Installation - Docs

This guide will walk you through installing Appwrite on your server using Docker. Appwrite is designed to run on any operating system that supports Docker.

System requirements

Before installing Appwrite, ensure your system meets these minimum requirements:

2 CPU cores
4GB of RAM
2GB of swap memory
Operating system that supports Docker
Docker Compose Version 2

Install with Docker

The easiest way to install Appwrite is using our Docker installer tool. This automated installer will guide you through the setup process.

Before running the installation command, ensure you have Docker CLI installed on your host machine.

Installation prompts

During setup, you'll be prompted to configure:

HTTP and HTTPS ports - Your Appwrite instance's HTTP and HTTPS ports.
Secret key - Your Appwrite instance's secret key used to encrypt sensitive data.
Main hostname - Your Appwrite instance's main hostname. Appwrite will generate a certificate using this hostname.
DNS A record hostname - Usually the same as your main hostname.

Installation commands

Run the following command in your terminal:

Bash

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:1.7.4

CMD

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:1.7.4

PowerShell

docker run -it --rm `
    --volume /var/run/docker.sock:/var/run/docker.sock `
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
    --entrypoint="install" `
    appwrite/appwrite:1.7.4

Manual installation

For advanced users who prefer manual setup, you can install Appwrite using Docker Compose directly.

Download configuration files

Download the required configuration files:

Download docker-compose.yml
Download .env
Create a directory named appwrite and move both files inside

Configure environment

Edit the .env file to customize your installation:

Update environment variables as needed
Set your desired configuration options
Ensure all required values are properly set

Start Appwrite

Once configured, start your Appwrite stack:

Bash

docker compose up -d --remove-orphans

Post-installation

After installation completes:

Access the Console - Navigate to your machine's hostname or IP address in your browser
Create an account - Sign up for your Appwrite account
Create your first project - Set up your development environment