Running a server¶
This section is for whoever runs Initiative for their group: installing it, configuring it, and keeping it alive.
If you only use Initiative, you can skip this entire section with a clear conscience. Everything you need is in Using Initiative.
You don't need to be a server expert
The recommended setup is Docker Compose, which is largely a matter of copying a file and editing a few values in it. If you can follow a recipe and edit a text file without panicking, you can run Initiative.
Everything deeper in this section is here for when you want it, not as a reading list you're behind on.
Not sure you want to run a server at all? A paid hosted service is on the way — see Self-host or let us host it.
What's in here¶
-
Installation
Get Initiative running with Docker Compose.
-
Configuration
The settings that control how your server behaves.
-
Single sign-on
Connect your identity provider (OIDC).
-
Email
Outgoing mail for invites and reminders.
-
Push notifications
Mobile push via Firebase.
-
File & object storage
Keep uploads on disk, or move them to S3.
-
Running plug-ins
The Initiative registry, and what each plug-in needs from you.
-
Publishing your own listings
Add your own dashboards, projects and plug-ins to the marketplace.
-
Platform roles
Server-wide roles, capabilities, and break-glass access.
-
Announcements
Tell everyone on your server something they have to act on.
-
Backups & updates
Protect your data and stay current.
-
Maintaining these docs
Build, preview, and publish this help center.
The first thing to know¶
The first person to register on a fresh server automatically becomes the owner — the top of the platform ladder, and the only role that can change server-wide settings.
So make absolutely sure the first sign-up is you, or whoever is actually going to run this. Not the enthusiastic colleague who wandered past while it was booting. See Platform roles.