Appearance

First run ​

Create the administrator account before inviting other users. The default authentication mode is local.

Choose an authentication mode ​

ModeBest for
localExcaliDash accounts
hybridLocal accounts and OpenID Connect
oidc_enforcedOpenID Connect only
disabledPersonal use in isolated environments only

Do not expose disabled authentication publicly

AUTH_MODE=disabled gives every visitor the same identity and access.

Create the administrator ​

Use the arrows to follow each screen of the default local-account setup. If authentication is already enabled, start at the administrator form.

Step 1 of 5
Enable authentication

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

Enable authentication — When a fresh instance asks you to choose an authentication mode, select Enable Authentication to secure the workspace.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
Get the one-time setup code — The administrator form opens. Read the BOOTSTRAP SETUP entry in your backend logs using the command below.Get the one-time setup code — The administrator form opens. Read the BOOTSTRAP SETUP entry in your backend logs using the command below.
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.

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.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.

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.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.

Create your first drawing — Select New Drawing in the empty workspace. The Excalidraw editor opens with an untitled, blank canvas.Create your first drawing — Select New Drawing in the empty workspace. The Excalidraw editor opens with an untitled, blank canvas.

Setup codes expire after 15 minutes by default.

Invite users ​

Open Admin to create another local account or enable self-registration.

Step 1 of 2
Open Admin

Open the account menu and select Admin. Use the registration setting if you want people to create their own accounts.

Open Admin — Open the account menu and select Admin. Use the registration setting if you want people to create their own accounts.Open Admin — Open the account menu and select Admin. Use the registration setting if you want people to create their own accounts.
Create a local user

Select New User, enter the account details and role, then create the user.

Create a local user — Select New User, enter the account details and role, then create the user.Create a local user — Select New User, enter the account details and role, then create the user.

For OpenID Connect (OIDC), configure the provider before signing in. OIDC_FIRST_USER_ADMIN=true makes the first provisioned OIDC user an administrator.

Your workspace ​

Use the arrows to explore an established example workspace, drawing sharing, and live collaboration.

Step 1 of 3
Organize drawings

This populated example shows collections and saved drawings. A new workspace starts empty; add your own drawings and collections.

Populated example workspace with drawings grouped into collectionsPopulated example workspace with drawings grouped into collections
Share a drawing

Open a drawing and select Share. Add a local account and choose its access level.

Share controls open for adding people and choosing permissionsShare controls open for adding people and choosing permissions
Collaborate in real time

Open the same drawing with invited collaborators. Their avatars and named cursors show who is working on the canvas.

Live deployment drawing with collaborator avatars and named cursorsLive deployment drawing with collaborator avatars and named cursors

Sample drawing credits.

Securing your instance ​

Before exposing ExcaliDash beyond a local machine:

  • Terminate TLS at a trusted reverse proxy.
  • Set stable JWT_SECRET and CSRF_SECRET values.
  • Keep TRUST_PROXY=false unless requests always pass through a trusted proxy.
  • Persist the database and test a restore procedure.
  • Keep frontend and backend image tags aligned.

Next: Configure authentication.

Self-hosted, open source, and built around Excalidraw.

Released under the GNU LGPL v3.0.