#Docker Compose [Recommend]

Docker Compose is the recommended method to self-host AFFiNE.

#Prerequisites

#Docker Compose

With Docker or other Docker compatible container service, you will be provided docker compose comand to run AFFiNE.

#Steps

#1. Create folders to put persisted data

mkdir affine
cd affine

#2. Get latest docker-compose.yml

You can choose to download the latest compose file tagged together with AFFiNE releases.

wget -O docker-compose.yml https://github.com/toeverything/affine/releases/latest/download/docker-compose.yml

or go to docker-compose.yml and copy the content, put it in manually created docker-compose.yml file in the folder created in Step 1.

#3. Get .env file

A .env file is required to configure docker volumes mapping to specific where the user data will be persisted at and other required environment variables.

wget -O .env https://github.com/toeverything/affine/releases/latest/download/default.env.example

or go to .env and copy the content, put it in manually created .env file in the folder created in Step 1.

Then, you need to update the .env file to correct the fields to your configurations.

The folder for Postgres data, usually to be the one in step 1 with '/postgres' suffix
DB_DATA_LOCATION=./postgres
The folder for uploaded blobs, usually to be the one in step 1 with '/storage' suffix
UPLOAD_LOCATION=./storage
The folder for custom configurations, usually to be the one in step with '/config' suffix
CONFIG_LOCATION=./config

DATABASE credentials and names to initialize Postgres
DB_USERNAME=affine
DB_PASSWORD=
DB_DATABASE=affine

#4. Start the containers

docker compose up -d

#5. Validate the deploy in browser

If everything goes perfect, you will be able to visit your AFFiNE in browser with http://localhost:3010. You might update the port to what you configured in .env file.

#Next steps

Read After Installation for things need to be done right after first time installation and Upgrade for instructions to upgrade your instances.