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.
- Read which mode the box is in, no shell into the host needed.
- Post an announcement to a Discord channel.
- Send a notice to the members you name.
What mode is this instance in
The console reads back the switches that shape the whole instance. The values it surfaces:
node_envand 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. To change one:
- Edit
.env. Each value maps to an environment variable. - Recreate the containers.
What each variable does is covered across Install, Email, and Privacy.
Announcements
- Wire a Discord webhook for the matching category. Without one, there is nothing to post to and you can skip the section.
- Post a short update from the Announcements section, for a release note or a feature you want to tell people about.
- Per-category toggles let you turn individual announcement types on or off and override the channel each goes to.
Notices to affected members
- Choose one or more workspaces (or specific users).
- Write a subject and body.
- Every matching member gets an in-app notification.
- Email too. 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.
- Targeted, not a broadcast. Unlike an announcement, which goes to a public channel, a notice goes only to the members you name.
The case a notice 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.