> ## Documentation Index
> Fetch the complete documentation index at: https://danswer-mintlify-deep-research-1773355783.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Recommended way to deploy Onyx in minutes

## Installation Script

The install script requires `Bash` to run so it works out of the box for Linux and MacOS. To run Onyx on Windows,
install Bash or refer to the [Docker](/deployment/local/docker) deployment.

To deploy with a single command:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh
```

<Accordion title="With Onyx Craft (unstable)">
  <Warning>
    Onyx Craft is currently unstable and under active development. Use in production environments is not recommended.
  </Warning>

  To deploy Onyx with **[Onyx Craft](/overview/core_features/craft)** enabled (Sandboxed agent):

  ```bash theme={null}
  curl -fsSL https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh --include-craft
  ```

  <Tip>
    See the [Craft documentation](/overview/core_features/craft) for full details on capabilities, configuration,
    and enabling Craft on existing deployments.
  </Tip>
</Accordion>

Alternatively, download and run the installation script below.

<Card title="Download Install Script" icon="download" href="https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/docker_compose/install.sh">
  Click here to download the install.sh script from GitHub.
</Card>

After downloading the script, run it with `bash ./install.sh`

The script will do the following:

* Check your system resources and requirements
* Pull the necessary deployment and configuration files
* Prompt the user for the version of Onyx to deploy and other basic information
* Pull the Onyx containers and start them in Docker

<Info>
  The script will create a directory called **onyx\_data** and there will also be a README in there with additional
  information.
</Info>

## Resourcing Overview

| Resource | Minimum                     | Preferred                             |
| -------- | --------------------------- | ------------------------------------- |
| CPU      | 4 vCPU                      | 8+ vCPU                               |
| RAM      | 10 GB                       | 16+ GB                                |
| Disk     | 32 GB + \~2.5x indexed data | 500 GB for organizations \<5000 users |

<Warning>
  Vespa (the vector database used by Onyx) does not allow writes once disk usage hits 75%.
</Warning>

For more details, our [Resourcing guide](/deployment/getting_started/resourcing) covers selecting Cloud instances,
resourcing by container, and how to scale your Onyx deployment.

## Next Steps

<CardGroup cols={2}>
  <Card title="Configure Authentication" icon="shield-check" href="/deployment/authentication/basic">
    Set up authentication for your Onyx deployment with OAuth, OIDC, or SAML.
  </Card>

  <Card title="More Onyx Configuration Options" icon="gear" href="/deployment/configuration/configuration">
    Learn about all available configuration options for your Onyx deployment.
  </Card>
</CardGroup>