Skip to main content

Instance settings

Most instance-wide configuration is set in .env and applied with a docker compose up -d, not toggled from the console. The console's job is to show you which switches are currently live, and to send messages out to your members.

What mode is this instance in​

The console reads back the switches that shape the whole instance, so "which mode is this box in" stops requiring a shell into the host. The values it surfaces:

  • node_env and the running build's commit.
  • public_signup: whether the login page accepts new registrations (see Invites and signups).
  • self_serve_invites: whether workspace owners can mint their own invites.
  • ai_enabled: whether the built-in AI features are turned on.
  • barcode_resolver_configured: whether a shared barcode resolver is wired in.

These are read-only here. Each maps to an environment variable; to change one, edit .env and recreate the containers. What each variable does is covered across Install, Email, and Privacy.

Announcements​

The Announcements section posts a short update to a Discord channel, for a release note or a feature you want to tell people about. It only does anything if you have wired a Discord webhook for the matching category; without one, there is nothing to post to and you can skip the section. Per-category toggles let you turn individual announcement types on or off and override the channel each goes to.

Notices to affected members​

A notice is a targeted message, not a broadcast. You choose one or more workspaces (or specific users), write a subject and body, and every matching member gets an in-app notification. If an email sender is configured, they also get an email, and that email is sent regardless of a member's notification preferences, the way a security or account message would be.

The case it is built for: something changed that affects how people reach or use their workspace, such as the instance's web address moving, and you need the people it touches to actually see it. Unlike an announcement, which goes to a public channel, a notice goes only to the members you name.