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

# API Self Hosted v3 – Quick Start Guide

> This guide will help you set up and run API Self Hosted v3 in a Docker-based environment. Follow the steps below to get up and running in minutes.

## Pre-requisites

### Software

Before you begin, make sure you have the following installed on your Linux server:

* A Linux distribution that supports Docker (or equivalent container runtime)
* Docker is installed and running
* Docker Compose plugin installed

### Hardware

Your server should meet the following minimum requirements:

* **Processor**: 4 cores running at 2.5 GHz (Intel Xeon 8000 series or better)
* **Memory**: 8 GB RAM minimum
* **Storage**: 20 GB free disk space

## Configuration Files

You can find the Docker Compose file and a sample `.env` configuration file at our GitHub repository:

<Card title="https://github.com/draftable/apish" href="https://github.com/draftable/apish" iconType="solid" icon="github" horizontal />

## Initial Deployment

<Steps>
  <Step title="Prepare your directory">
    On your Linux server, create a dedicated folder that contains your `.env` file and the Docker Compose file. Adjust the settings in the `.env` file to suit your use case.

    <Note>
      **Note:** You can pre-configure your product key in the `.env` file.
      Example:

      ```bash theme={null}
      DRAFTABLE_PRODUCT_KEY=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
      ```
    </Note>

    <Tip>
      **Upgrading from v2?** Your existing v2 product key is fully compatible with v3. No new key is required.
    </Tip>
  </Step>

  <Step title="Navigate to the directory and deploy the container">
    First ensure you are currently operating within the directory where the compose file and .env exists. 

    ```bash theme={null}
    cd /location_of_your_directory
    ```

    Run the following command from inside your deployment folder:

    ```bash theme={null}
    docker compose up
    ```
  </Step>

  <Step title="Note">
    Add the `-d` flag if you want to run the container in the background:

    ```bash theme={null}
    docker compose up -d
    ```
  </Step>

  <Step title="Access the UI">
    Open your browser and navigate to the HTTPS address you configured in your `.env` and Compose files.

    Example:

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-2.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=9675811832ce068d570991aff80056a2" alt="" width="201" height="40" data-path="images/image-2.png" />
    </Frame>
  </Step>

  <Step title="Set up the Administrator account">
    On first launch, you will be prompted to create an Administrator account.

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-3.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=5003e0fe86969389c287a8ff41f297ee" alt="" width="574" height="686" data-path="images/image-3.png" />
    </Frame>

    <br />

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-4.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=2844b4c0a09955d32be45d7304ef30f7" alt="" width="530" height="332" data-path="images/image-4.png" />
    </Frame>
  </Step>

  <Step title="Log in as Administrator">
    After creating your account, log in with the Administrator credentials. 

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-5.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=d5d967189af9ae7231064ca8cb7cfb40" alt="" width="574" height="623" data-path="images/image-5.png" />
    </Frame>

    <br />

    You now have full UI access to the container.

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-6.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=e6d0ecc85061c85c4a3925649617ff32" alt="" width="1172" height="919" data-path="images/image-6.png" />
    </Frame>
  </Step>

  <Step title="Retrieve your API credentials">
    Navigate to **Account Settings** within the Administrator portal to view your API credentials. 

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-7.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=30c5559e915b64f93470e2ae9984bcf4" alt="" width="243" height="222" data-path="images/image-7.png" />
    </Frame>

    With these credentials, you can now start using the API.

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-8.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=31fb2fc278910ac138417970e881bba6" alt="" width="1210" height="819" data-path="images/image-8.png" />
    </Frame>
  </Step>

  <Step title="Manage users and settings">
    Use the Administrator portal to modify user accounts, update settings, and manage your deployment. Selecting the **Account settings** of the user you wish to configure will open the Django administration page.

    <Frame>
      <img src="https://mintcdn.com/draftable/03NpPs9iBLAbF1Vt/images/image-9.png?fit=max&auto=format&n=03NpPs9iBLAbF1Vt&q=85&s=71f43c5995ecc8d3d96cca38d34323fb" alt="" width="1197" height="689" data-path="images/image-9.png" />
    </Frame>

    Here you can configure the settings for the user account. These settings impact things like file size limitations, UI configuration and default values with comparison UI. 

    <Frame>
      <img src="https://mintcdn.com/draftable/PNuzpyDjwEVWCtnb/images/image-10.png?fit=max&auto=format&n=PNuzpyDjwEVWCtnb&q=85&s=86f7c0b2b12c9f606d1e5d3e49273f7b" alt="" width="1904" height="864" data-path="images/image-10.png" />
    </Frame>
  </Step>

  <Step title="You are now ready to use API Self Hosted v3!">
    ✅ You are now ready to use API Self Hosted v3! If you are having any issues deploying or problems related to the new image version, please get in touch at [support@draftable.com](mailto:support@draftable.com).
  </Step>
</Steps>

✅ You are now ready to use API Self Hosted v3! If you are having any issues deploying or problems related to the new image version, please get in touch at [support@draftable.com](mailto:support@draftable.com).