Skip to content
v2.19.3GitHub

Excaliself

Sign in to the Excaliself whiteboard with Pocket ID.

  • Self-hosted Excaliself with BASE_URL set to the address you open it at, such as https://excaliself.example.com. The callback URL is <BASE_URL>/api/auth/callback/oidc.
  1. In Pocket ID, open Administration → OIDC Clients and click Add OIDC Client.
  2. Enter a name such as Excaliself and add the callback URL https://excaliself.example.com/api/auth/callback/oidc.
  3. Click Create and copy the Client ID and the Client secret. Under Show more details, also copy the Issuer URL. The client secret is only shown once.
  4. On the client’s General tab, turn on PKCE, then click Save.
  5. On the client’s Access tab, select the groups that may sign in under Allowed User Groups, or choose All Users.

Open Administration → Users and select each user that should have access. If the icon next to the email isn’t green, click it to mark the email as verified, then save.

  1. Add the OIDC variables to the .env file next to Excaliself’s docker-compose.yaml, with the values from Pocket ID:
    OIDC_ISSUER=https://id.example.com
    OIDC_CLIENT_ID=<client-id>
    OIDC_CLIENT_SECRET=<client-secret>
    OIDC_NAME=Pocket ID
    OIDC_ISSUER is the Issuer URL, the address of Pocket ID.
  2. Optional: To let new users get an account on their first sign-in, add their email domains, separated by commas:
    SSO_ALLOWED_DOMAINS=example.com
    Without it, new users need an invite link from an Excaliself admin.
  3. Restart Excaliself with docker compose up -d.

The sign-in page now shows a Continue with Pocket ID button.