Skip to content

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.

Simplified Chinese

Getting Started ​

DocumentCovers
Quick startThe shortest path to a running site

Installation & Configuration ​

DocumentCovers
DeploymentInstalling, the first site and administrator, domains and HTTPS, running as a system service
Configurationpwikit.toml, environment variables and how settings combine
Command lineEvery pwikit command and option

Migration & Build ​

DocumentCovers
Importing from WikidotBringing a Wikidot site over from a wikitCLI backup
Migrating from the Python releaseMoving an existing ProjectWikit installation to this release
Building from sourceCompiling pwikit yourself and making release packages

Maintenance & Updates ​

DocumentCovers
OperationsServices, logs, backups, upgrades
Updating and rolling backAutomatic and manual updates, rollbacks and mirrors

Plugins & Mounts ​

DocumentCovers
PluginsInstalling and enabling plugins, and writing them
Mounting other programsForwarding a path on the site to another program, reader identity and notifications

Site Administration ​

DocumentCovers
Site administrationThe admin panel: site settings, users, roles and permissions, moderation
Roles and permissionsHow permissions are decided, the permission list, member sanctions, and what differs from Wikidot

Usage Guide ​

DocumentCovers
FeaturesAn overview of what members can do
SyntaxWikitext reference
Modules[[module]] reference