Wiki.js

BETA Warning

This wiki is for the Wiki.js 3.0 BETA release. For the stable 2.x version documentation, go to docs.requarks.io.

Wiki.js is a powerful knowledge base platform to write and share documentation.

Getting Started

Wiki.js is quick and easy to install. You'll be up and running in no time.

User Guide

Check out the basics page to get started.

  • Basics — Learn the basics of Wiki.js
  • Content Blocks — Add dynamic content to your pages
  • Editors — Discover the available editors to write content
  • File Manager — Manage assets and pages
  • Glossary — Define terms used across your wiki
  • Inbox & Notifications — Watch pages, review submissions and be notified of pages requiring your attention
  • Live Collaboration — Write pages with other users in real-time
  • Markdown — Syntax to write Markdown content
  • Navigation — Manage the sidebar navigation
  • Page History — View, compare and restore revisions of a page
  • Page Operations — Move, duplicate and delete pages
  • Page Properties — Edit page metadata and configuration
  • Page Source — View the original source code of a page before being rendered
  • Profile — Manage your user info and settings
  • Search — Search across all pages and filter results
  • Suggest Edits — Allow read-only users to submit edits to existing pages and review them before publishing
  • Tags — Organize your pages using tags

Administration

The administration area dashboard is your entry point to managing your wiki.

  • Approvals — Define which pages accept edit suggestions from read-only users, and who reviews them
  • Audit Log — A log of all events by users across the wiki for auditing purposes
  • Authentication — Configure the authentication settings of your wiki
  • Content Blocks — Manage dynamic components available for use inside pages.
  • Dashboard — Overview of the Administration Area
  • Editors — Manage editors and their configuration
  • Extensions — Install extensions for extra functionality
  • Flags — Low-level system flags for debugging or experimental purposes
  • General — Configure the main settings of your wiki
  • Groups — Manage user groups and permissions
  • Icons — Choose which icon sets can be used across the wiki
  • Instances — View a list of active instances
  • Locale — Set localization options for your wiki
  • Login — Configure the login user experience of your wiki site
  • Mail Configuration — Configure the mail server to send emails from Wiki.js
  • Metrics — Manage the Prometheus metrics endpoint
  • Permissions — Manage access to your pages
  • Scheduler — View scheduled and completed jobs
  • SCIM Provisioning — Let an identity provider create and deactivate accounts
  • Search Engine — Configure the search capabilities of your wiki
  • Security — Configure security settings
  • Site Management — Host multiple wikis on the same Wiki.js server
  • Storage — Choose where the content of your wiki is stored and served from
  • System Info — Information about your server / client
  • Terminal — View server logs in real-time
  • Theme — Modify the look & feel of your wiki
  • Troubleshooting / FAQs — Solutions to common issues / Frequently Asked Questions
  • Users — Manage Users
  • Utilities — Maintenance and miscellaneous tools
  • Webhooks — Manage webhooks to external services

Developers

Read the getting started page to setup your development environment first.

  • API — Build automations by using the Wiki.js REST API
  • Custom Blocks — Create your own content blocks
  • MCP — Manage the Model Context Protocol server
  • Modules — Develop your own custom modules for Wiki.js
  • Translations — Help translating Wiki.js in your language!