Coming soon. The Wiki is in active development, so features and these docs may still change. Early adopters: contact us for access.

Wiki Admin Guide

Install, license, configure, secure and run the Wiki: everything administrators and operators need

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

  1. Plan — Choose a single server or a cluster, and size PostgreSQL, Redis and file storage. Plan an installation
  2. 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
  3. License — Read the installation ID and request a licence. Licensing
  4. Set up — In the setup wizard, or without the UI from a YAML file.
  5. Configure — The Wiki's address, email, directories and single sign-on, storage. Settings reference
  6. Decide what's public — Anonymous readers, public spaces and questions, and what search engines may index. Anonymous access, Search engines
  7. Secure — Work through the production checklist.
  8. Operate — Backups, the system check, monitoring, alerts and upgrades.

2. Who administers what

RoleCanTypical person
Super adminEverything: installation settings, licence, storage, backups, plugins, every space, labels; only super admins create spacesPlatform team
Organization adminPeople, groups, roles and policies of their organization; moderates its Q&ATeam or department lead
Space adminA space's members, settings, imports and deletionTeam that owns the space
Operator (no role in the Wiki)The servers, PostgreSQL, Redis, storage, the reverse proxy and the environmentInfrastructure / SRE

How access fits together shows how system roles, groups and space roles combine.

3. In this guide

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.