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. The installer launches a web-based setup wizard that guides you through the entire process.

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

Firewall configuration

The installation wizard runs on port 20080. If you are installing on a remote server, ensure that port 20080 is open in your firewall or security group settings before proceeding. You can close this port after installation is complete.

Installation commands

Run the following command in your terminal:

Bash

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

CMD

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

PowerShell

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

Once the command is running, open your browser and navigate to http://localhost:20080 to access the setup wizard.

Setup wizard

The setup wizard walks you through four steps to configure your Appwrite instance.

Step 1: Setup your app

Configure your Appwrite instance's basic settings.

Setup your app

Hostname - The domain or IP address where your Appwrite instance will be accessible.
Database - Choose between MongoDB or MariaDB as your database backend. MongoDB is selected by default.
Advanced settings - Optionally configure HTTP and HTTPS ports, SSL certificate email, and an OpenAI API key for the Appwrite Assistant.

Step 2: Secure your app

A secret API key is automatically generated for your instance. This key is used to encrypt sensitive data.

Secure your app

Save your key

You won't be able to see this key again after proceeding. Copy it somewhere safe before continuing.

You can use the Copy button to copy the key or Regenerate to create a new one.

Step 3: Create your account

Set up the email and password for your Appwrite account. You'll use these credentials to sign in to the Appwrite Console after installation.

Create your account

Step 4: Review your setup

Review all your configuration settings. If anything looks wrong, use the Back button to make changes. When you're ready, click Install to begin the installation.

Review your setup

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 your first project - Set up your development environment