> ## Documentation Index
> Fetch the complete documentation index at: https://docs.briefer.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Briefer is the modern open-source BI and data science tool.

## What is Briefer

Briefer is like Notion for code notebooks and dashboards. It gives technical users all the flexibility they need to publish dashboards, analyze data, create reports, and build data apps. At the same time, Briefer makes it easy for non-technical users to view and interact with data.

<Frame>
  <video controls={false} muted autoPlay playsInline className="w-full aspect-video" src="https://briefer.cloud/demo-header-v2.mp4" />
</Frame>

In Briefer, you can:

* 📚📊 **Create notebooks and dashboards** using Markdown, Python, SQL, and native visualizations.
* 🤳 **Build interactive data apps** using inputs, dropdowns, and date pickers.
* 🕰️ **Schedule notebooks and dashboards** to run and update periodically.
* ⚙️ **Create and test ad-hoc pipelines** using writebacks.
* 🤖 **Generate code and queries** using an AI that understands your database schema and your notebook's context.

In addition to all that, Briefer is also multiplayer, meaning two or more people can work on the same notebook or dashboard at the same time and see each other's changes in real-time.

## Getting started

There are three ways to set up Briefer. You can install it on your machine for individual use, sign up for the cloud for a more convenient collaborative workspace, or you can deploy it to your own infrastructure. All of these options are free.

We recommend that you either sign-up for the cloud or deploy it yourself. That way, your whole team will be able to collaborate in Briefer.

<CardGroup cols={2}>
  <Card title="Local quickstart" icon="computer" href="./get-started/local">
    Get Briefer running on your machine.
  </Card>

  <Card title="Cloud quickstart" icon="cloud" href="./get-started/cloud">
    Set up a workspace in our cloud.
  </Card>

  <Card title="Deploy Briefer" icon="users" href="./get-started/deploy">
    Deploy Briefer for your whole team to use.
  </Card>
</CardGroup>

## Product documentation

<CardGroup cols={2}>
  <Card title="First steps" icon="shoe-prints" href="./product/first-steps">
    The first things you should do after setting up Briefer.
  </Card>

  <Card title="Interface overview" icon="map" href="./product/interface-overview">
    A quick overview on Briefer's interface and how to use it.
  </Card>

  <Card title="Data sources" icon="database" href="./product/data-sources">
    Connect your databases to Briefer.
  </Card>

  <Card title="Inputs" icon="pen-to-square" href="./product/inputs">
    Add text inputs, dropdowns, and date pickers to your pages.
  </Card>

  <Card title="Files" icon="folder-open" href="./product/files">
    Upload files to Briefer and use them.
  </Card>

  <Card title="Schema explorer" icon="book" href="./product/schema-explorer">
    Explore your database's schema and data.
  </Card>

  <Card title="Schedules" icon="calendar" href="./product/schedules">
    Schedule your pages to run and update periodically.
  </Card>

  <Card title="Snapshots" icon="camera" href="./product/snapshots">
    See how your pages evolved over time and restore them.
  </Card>

  <Card title="Reusable components" icon="cubes-stacked" href="./product/reusable-components">
    Turn blocks into components you can reuse across pages.
  </Card>

  <Card title="Sharing and exporting" icon="share-nodes" href="./product/sharing">
    Share your pages with others or export them
  </Card>

  <Card title="Environments" icon="microchip" href="./product/environments">
    Configure the environments in which your code runs.
  </Card>

  <Card title="Environment variables" icon="key" href="./product/environment-variables">
    Store keys, settings, and other values as environment variables that you can
    use.
  </Card>

  <Card title="AI assistant" icon="wand-magic-sparkles" href="./product/environment-variables">
    Use AI to generate code and queries for you.
  </Card>

  <Card title="Slack integration" icon="slack" href="./product/slack-integration">
    Get your pages sent periodically on Slack.
  </Card>

  <Card title="Keyboard shortcuts" icon="keyboard" href="./product/keyboard-shortcuts">
    Use keyboard shortcuts for convenience and speed.
  </Card>

  <Card title="Private Documents" icon="person-chalkboard" href="./product/private-documents">
    Allow users to create private documents. Ideal for individual scratchpads.
  </Card>
</CardGroup>

## Settings and management

<CardGroup cols={2}>
  <Card title="Installing packages" icon="hard-drive" href="./settings/installing-packages">
    Install new Python packages into your environment.
  </Card>

  <Card title="User management" icon="user-plus" href="./settings/user-management">
    Invite others and manage permissions.
  </Card>

  <Card title="Workspace settings" icon="gear" href="./settings/workspace-settings">
    Configure your workspace.
  </Card>

  <Card title="Page settings" icon="scroll" href="./settings/page-settings">
    Change page-specific settings.
  </Card>
</CardGroup>

## Enterprise-specific documentation

<CardGroup cols={2}>
  <Card title="Permissions - Self-hosted" icon="passport" href="./enterprise/deployment-permissions">
    Permissions and setup required for deploying Briefer's enterprise version on Kubernetes.
  </Card>

  <Card title="SSO - Self-hosted" icon="lock" href="./enterprise/sso-self-hosted">
    Configure Briefer to use your single sign-on provider on your self-hosted Briefer instance.
  </Card>

  <Card title="Data source identities" icon="lock" href="./enterprise/sso-self-hosted">
    Configure Briefer to forward user identities to your data source providers. That way you can authenticate and authorize users with the data source provider.
  </Card>

  <Card title="Granular permissions" icon="user-plus" href="./enterprise/granular-permissions">
    Manage permissions on a per-page basis.
  </Card>

  <Card title="Private AI setup" icon="hat-wizard" href="./enterprise/private-ai">
    Configure your self-hosted Briefer deployment to use AI services in your own AWS account.
  </Card>

  <Card title="Customize appearance" icon="paintbrush" href="./enterprise/customize-appearance">
    Customize the appearance of your workspace to match your brand.
  </Card>

  <Card title="Configuring caches" icon="hard-drive" href="./enterprise/configuring-caches">
    Configure your query caches to optimize performance and reduce costs.
  </Card>
</CardGroup>
