Quick start

Run ExcaliDash with Docker Compose.

Prerequisites

• Docker Engine or Docker Desktop
• Docker Compose v2
• Port 6767 available on the host

Start ExcaliDash

1. Clone the repository:

   git clone https://github.com/ZimengXiong/ExcaliDash.git
   cd ExcaliDash

2. Start the services:

   docker compose -f docker-compose.prod.yml up -d

3. Open http://localhost:6767.

4. Create the administrator account.

Set up your administrator account

Use the arrows to follow the complete first-run flow, from choosing authentication to opening your first drawing. Each screenshot follows this page's light or dark theme.

Step 1 of 5

Enable authentication

When a fresh instance asks you to choose an authentication mode, select Enable Authentication to secure the workspace.

Get the one-time setup code

The administrator form opens. Read the BOOTSTRAP SETUP entry in your backend logs using the command below.

docker compose -f docker-compose.prod.yml logs --tail=200 backend

Enter the administrator details

Enter your name, email, password, and the one-time code from your own server. Select Create account. The screenshot shows a disposable example account.

Start with an empty workspace

After creating the administrator account, you are signed in. All Drawings is initially empty; no sample drawings are added automatically.

Create your first drawing

Select New Drawing in the empty workspace. The Excalidraw editor opens with an untitled, blank canvas.

Check the services

docker compose -f docker-compose.prod.yml ps
docker compose -f docker-compose.prod.yml logs -f

Stop the stack

docker compose -f docker-compose.prod.yml down

For a server deployment, see Deploy with Docker Compose.