ProjectWikit documentation
ProjectWikit is a Wikidot-compatible wiki engine. One pwikit executable serves one or more wikis, with a PostgreSQL database bundled or supplied by you.
Getting Started
| Document | Covers |
|---|---|
| Quick start | The shortest path to a running site |
Installation & Configuration
| Document | Covers |
|---|---|
| Deployment | Installing, the first site and administrator, domains and HTTPS, running as a system service |
| Configuration | pwikit.toml, environment variables and how settings combine |
| Command line | Every pwikit command and option |
Migration & Build
| Document | Covers |
|---|---|
| Importing from Wikidot | Bringing a Wikidot site over from a wikitCLI backup |
| Migrating from the Python release | Moving an existing ProjectWikit installation to this release |
| Building from source | Compiling pwikit yourself and making release packages |
Maintenance & Updates
| Document | Covers |
|---|---|
| Operations | Services, logs, backups, upgrades |
| Updating and rolling back | Automatic and manual updates, rollbacks and mirrors |
Plugins & Mounts
| Document | Covers |
|---|---|
| Plugins | Installing and enabling plugins, and writing them |
| Mounting other programs | Forwarding a path on the site to another program, reader identity and notifications |
Site Administration
| Document | Covers |
|---|---|
| Site administration | The admin panel: site settings, users, roles and permissions, moderation |
| Roles and permissions | How permissions are decided, the permission list, member sanctions, and what differs from Wikidot |
Usage Guide
| Document | Covers |
|---|---|
| Features | An overview of what members can do |
| Syntax | Wikitext reference |
| Modules | [[module]] reference |
