papra

---
title: Using Docker Compose
slug: self-hosting/using-docker-compose
description: Self-host Papra using Docker Compose.
---

import { Steps } from '@astrojs/starlight/components';
import { Tabs, TabItem } from '@astrojs/starlight/components';
import SecretKeyGenerator from '../../../components/random-hex-key-generator.astro';

This guide covers how to deploy Papra using Docker Compose, ideal for users who prefer declarative configurations or plan to integrate Papra into a broader service stack.

Using Docker Compose provides:
- A single, versioned configuration file
- Easy integration with volumes, networks, and service dependencies
- Simplified updates and re-deployments

This method supports both `rootless` and `rootful` Papra images, please refer to the [Docker](/self-hosting/using-docker) guide for more information about the difference between the two. The following example uses the recommended `rootless` setup.

## Prerequisites

Ensure Docker and Docker Compose are installed on your host system. Official installation guides are available at: [docker.com/get-started](https://www.docker.com/get-started)

Verify Docker installation with:

```bash
docker --version
docker compose version
```


<Steps>

1. Initialize Project Structure

    Create working directory and persistent storage subdirectories:

    ```bash
    mkdir -p papra/app-data/{db,documents} && cd papra
    ```

2. Generate an Auth Secret

    Papra requires an `AUTH_SECRET` to run. Generate a secure one using the generator below or the OpenSSL command:

    <Tabs>
      <TabItem label="Key generator">
        <SecretKeyGenerator byteLength={48} />
      </TabItem>
      <TabItem label="OpenSSL command">
        ```bash
        openssl rand -hex 48
        ```
      </TabItem>
    </Tabs>

    Keep the value handy, you will set it as an environment variable in the next step.

3. Create Docker Compose file

    Create a file named `docker-compose.yml` with the following content (replacing `<your-auth-secret>` with the value generated in the previous step):

    ```yaml
    services:
      papra:
        container_name: papra
        image: ghcr.io/papra-hq/papra:latest
        restart: unless-stopped
        ports:
          - "1221:1221"
        environment:
          - AUTH_SECRET=<your-auth-secret>
        volumes:
          - ./app-data:/app/app-data
        user: "${UID}:${GID}"
    ```

4. Start Papra

    From the directory containing your `docker-compose.yml` file, run:

    ```bash
    UID=$(id -u) GID=$(id -g) docker compose up -d
    ```

    This command downloads the latest Papra image, sets up the container, and starts the Papra service. The `UID` and `GID` variables are used to set the user and group for the container, ensuring proper file ownership. If you don't want to use the `UID` and `GID` variables, you can replace the image with the rootful variant.

5. Access Papra

    Once your container is running, access Papra via your browser at:

    ```
    http://localhost:1221
    ```

    Your Papra instance is now ready for use!

6. To go further

    Check the [configuration](/self-hosting/configuration) page for more information on how to configure your Papra instance.

</Steps>

## Maintenance

Check logs

```bash
docker compose logs -f
```

Stop the service

```bash
docker compose down
```

Update Papra

```bash
docker compose pull
docker compose up -d
```

You're all set! Enjoy managing your documents with Papra.