This guide is for the people who install and run the Wiki: platform and infrastructure engineers, the Wiki's super admins and organization admins, and security teams. People who read and write pages need the user guide instead. Pages both need, such as spaces, API tokens and the changelog, are in both guides.
The Wiki isn't released yet. Early adopters: contact us for access to get the server and a licence.
1. From nothing to production
- Plan — Choose a single server or a cluster, and size PostgreSQL, Redis and file storage. Plan an installation
- Install — Start the server and the web app, and put a reverse proxy in front that sends /api/ws to the server. Install the Wiki
- License — Read the installation ID and request a licence. Licensing
- Set up — In the setup wizard, or without the UI from a YAML file.
- Configure — The Wiki's address, email, directories and single sign-on, storage. Settings reference
- Decide what's public — Anonymous readers, public spaces and questions, and what search engines may index. Anonymous access, Search engines
- Secure — Work through the production checklist.
- Operate — Backups, the system check, monitoring, alerts and upgrades.
2. Who administers what
| Role | Can | Typical person |
|---|---|---|
| Super admin | Everything: installation settings, licence, storage, backups, plugins, every space, labels; only super admins create spaces | Platform team |
| Organization admin | People, groups, roles and policies of their organization; moderates its Q&A | Team or department lead |
| Space admin | A space's members, settings, imports and deletion | Team that owns the space |
| Operator (no role in the Wiki) | The servers, PostgreSQL, Redis, storage, the reverse proxy and the environment | Infrastructure / SRE |
How access fits together shows how system roles, groups and space roles combine.
3. In this guide
| Section | Pages |
|---|---|
| Install | Plan an installation · Install the Wiki · Single server & cluster · Environment variables |
| Set up | Setup wizard · Set up without the UI · Licensing · Recovery mode |
| Configure | Settings reference · How access fits together · Users & directories · Single sign-on · OAuth applications · API tokens · Rate limits · Storage · Email · Branding |
| Spaces & content | Spaces · Analytics · Calendar feeds · Imports · Q&A moderation |
| Security | Production checklist · Anonymous access · Search engines · Policies · Logging & audit · Personal data |
| Operate | System check · Alert tuning · Monitoring · Backups · Upgrades · Scheduled jobs · Managing alerts · Events · Automation · Plugins |
| Help | Known issues · FAQ · Support · Changelog |
4. Getting help
Licences, renewals and questions: vectored.dev/#contact or support@vectored.dev. For a problem with a running installation, Support says what to send so it can be answered the first time.