WARNING This site is for the unreleased, still under development 3.0 version of Wiki.js. Go to the current 2.5 version instead.

Users, Groups & Permissions

While a good wiki is one where anyone can contribute new content, it's always a good idea to restrict certain sections and specific actions to a list of selected users.

Wiki.js has a powerful permission system with fine grained control over what your users can see and do.

Concepts

The permission system of Wiki.js is based on 4 concepts: Users, Groups, Rules and Permissions.

A user can be part of one or more groups.

A group defines what the user can see and can do. This is achieved using Rules and Permissions.

Rules apply to content (e.g. read / write a page, upload assets, write comments, etc.) while Permissions are for administrative tasks (e.g. create users, change site settings, etc.)

Group Properties

TODO

Rules

A rule consists of a set of actions a user can perform on a specific set of pages. Rules can restrict access to certain paths, on specific sites and locales.

TODO

Permissions

A permission allows a user to perform a specific set of actions related to the administration of the wiki. Contrary to Rules which govern content, Permissions are strictly for management rights.

API

PermissionDescriptionNotes
read:apiCan list existing API keys.
manage:apiCan generate and revoke API keys.Cannot generate keys with the Administrators group rights.

Groups / Users

PermissionDescriptionNotes
read:usersCan list and view any user.
write:usersCan create or authorize new users, but not modify existing ones.Cannot assign to Administrators group.
manage:usersCan edit existing users.Cannot modify users from Administrators group.
read:groupsCan list and view any group.
write:groupsCan create and edit new groups and assign Rules.Cannot set Permissions.
manage:groupsSame as write:groups but can set Permissions.Cannot set the manage:system permission.

Sites

PermissionDescriptionNotes
read:sitesCan list and view a site configuration.
write:sitesCan create new sites, but not modify existing ones.Cannot create a site with a wildcard * hostname.
manage:sitesCan edit and delete existing sites.
manage:themeCan modify theme settings.

System

PermissionDescriptionNotes
read:dashboardCan access the administration area and view dashboard stats.
read:metricsCan access the /metrics prometheus endpoint.
manage:systemCan manage and access everything.

Webhooks

PermissionDescriptionNotes
read:webhooksCan list existing webhooks and their configuration.
write:webhooksCan create new webooks, but not modify existing ones.
manage:webhooksCan edit and delete existing webhooks.

Users

Users are managed via the Administration Area, under the Users section.

Create New User

TODO

Edit User

TODO

Delete User

TODO