--- title: "Wiki Plugin for Orangescrum Self-Hosted" description: "Internal knowledge base inside Orangescrum. Spaces, page history, review before publish, granular permissions, and a public docs portal. Self-hosted." canonical: https://www.orangescrum.com/self-hosted/plugins/wiki --- # Wiki Plugin for Orangescrum Self-Hosted > For the complete documentation index, see [llms.txt](https://www.orangescrum.com/llms.txt). 1. [Home](/) 2. › 3. [Self-Hosted](/self-hosted) 4. › 5. [Plugins](/self-hosted/plugins) 6. › 7. Wiki # Wiki by [Orangescrum](/) · Productivity Self-HostedVerifiedKnowledge Base A documentation workspace built into Orangescrum. Organise knowledge into shelves, spaces, and a nested page tree. Every save creates a revision you can compare and restore. Pages can be sent to a named reviewer and only publish once that reviewer approves. Permissions are set per space and per page, and anything you choose can be published to a read-only portal for readers outside the workspace. Installs Available Active deployments Support Vendor Supported Priority response Trust Self-Hosted Your infra, your data $499/year Per company • Add-on to any Self-Hosted plan [Buy & See All Plans](/self-hosted/pricing#addons)[Talk to Sales](/contact-sales) - Shelves, spaces, and a nested page tree - Full revision history with restore - Review and approval before a page publishes - Permissions per space and per page - Public docs portal with reader feedback - Search across spaces, with backlinks - Action items and linked Orangescrum tasks - Wiki REST API with per-company API keys Pairs with [Self-Hosted Core ($1,500/yr) or Business ($2,250/yr)](/self-hosted/pricing) [Overview](#overview)[Features](#features)[About](#about)[Install](#install)[FAQ](#faq) ## Screenshots Space library with shelves and nested page tree Page review with reviewer decision and revision history Public docs portal with search and article feedback ## Key Features ### Shelves, Spaces and Books Group knowledge the way your organisation is actually shaped. Shelves hold spaces, spaces hold books and pages, so people find things without asking anyone. ### Nested Page Tree Pages nest as deep as the subject needs. Move, copy, and reorder pages without breaking the links that point at them. ### Revision History Every save is a revision. Read any earlier version, see what changed, and restore it in one action when a good page gets edited into a bad one. ### Review Before Publish Send a page to a named reviewer. It sits in review until that reviewer approves it, and approval publishes the page. Changes can be requested instead, with a note. ### Space and Page Permissions Grant view, create, edit, comment, and delete separately. Rules apply to everyone, anonymous readers, a single user, a role, or a role group, on a space or one page. ### Comments and Reactions Comment on a page or anchor a comment to a passage. React to comments and resolve them, so a page discussion ends instead of drifting. ### Attachments Attach files to any page, lock an attachment so it cannot be replaced, or link a file that already lives in the Document Management repository instead of uploading it twice. ### Search and Backlinks Search titles and body text across every space you can see, with an advanced filter view. Backlinks on each page show what else references it before you change or archive it. ### Action Items Turn a decision on a page into a tracked action item with an owner. A personal view collects every action item assigned to you across all spaces. ### Linked Project Work Create an Orangescrum task straight from a page, or link an existing one. Pages also link to projects and tasks, so the write-up and the work sit together. ### Watchers and Notifications Watch a page or a space and get notified when it changes, when you are mentioned, or when a review needs your decision. ### Archival Rules Define rules that archive stale pages on a schedule, review what was archived, and restore anything archived by mistake. Old content stops crowding search results. ### Public Docs Portal Publish chosen spaces to a read-only portal with its own home, book, page, and search views. Readers can leave feedback on an article without an account. ### Page Analytics See views per page and what people searched for, then export the data. You learn which pages earn their place and which questions your docs never answer. ### Import and Export Import existing content into a space and export any page to .docx when someone outside the workspace needs a copy. ### Wiki API and Audit Log A REST API with per-company keys covers spaces, pages, and attachments. An audit log records who did what to which page. ## About this plugin ### Why Wiki for Orangescrum? Most teams write things down in a tool that knows nothing about their projects. The onboarding guide, the runbook, the decision record, and the architecture note all end up somewhere the delivery team does not open every day. Wiki puts that writing in the same workspace as the work, so a page can link to the task it describes and a task can link back to the page that explains it. ### Structure people can navigate Knowledge is organised into shelves, spaces, and a nested page tree. A space usually maps to a team, a product, or a subject area. Inside it, pages nest as deep as the topic needs. Pages can be moved and copied without breaking references, and backlinks show you what points at a page before you change it. ### Nothing publishes by accident A page can be sent to a named reviewer. It stays in review until that reviewer approves it, and approving it publishes the page. A reviewer can request changes instead and leave a note explaining why. Every submit and decision is recorded, so you can show how a published page got there. ### Permissions that go down to a single page View, create, edit, comment, and delete are granted separately. A rule can target everyone, anonymous readers, one user, a role, or a role group, and it can apply to a whole space or to one page inside it. That is enough to run an open company handbook and a restricted security runbook on the same install. ### Docs for readers outside the workspace Chosen spaces can be published to a read-only portal with its own home page, book view, page view, and search. Readers can leave feedback on an article. Because the install is yours, the portal runs on your domain and behind whatever network controls you already have. ### Wiki in Cloud and in Self-Hosted Wiki is available in the Cloud edition as well. This page covers the self-hosted add-on. The difference is control: every page, revision, attachment, permission rule, and analytics row sits in your own PostgreSQL database, retention is yours to set, and the public portal is served from infrastructure you run. Nothing leaves your network. ### What's included - Shelves, spaces, and books with a nested page tree of unlimited depth - Page editor with reusable templates - Full revision history with restore and per-revision content view - Review workflow: submit to a named reviewer, approve to publish, or request changes - Permissions for view, create, edit, comment, and delete - Permission subjects: everyone, anonymous, user, role, and role group - Space-level and page-level permission rules - Comments with passage anchors, reactions, and resolve - Attachments with upload, lock, and linking to Document Management files - Full-text search across spaces, plus an advanced search view - Backlinks and internal page links - Mentions that notify the person mentioned - Action items on pages, plus a personal action item view - Create an Orangescrum task from a page, or link an existing task - Page links to projects and tasks - Watchers and in-app notifications - Archival rules with scheduled runs, an archived list, and restore - Public docs portal with home, book, page, search, and article feedback - Per-page sharing links for individual documents - Page view analytics and search analytics, with export - Content import and .docx export - Structured databases with custom fields and rows - Forms with stored submissions - Space calendar and events - Wiki REST API with per-company API keys covering spaces, pages, and attachments - Audit log of page and space activity - Optional connection to an external BookStack wiki, linked to projects and tasks - Multi-tenant company-scoped data isolation ### Compatibility Requires the Orangescrum Self-Hosted edition running PHP 8.2+, CakePHP 4.6+, and PostgreSQL 16. Full-text search uses PostgreSQL trigram indexes created by the plugin migrations. Real-time co-authoring on wiki pages is not part of this add-on: it becomes available only when the CollabDocs component that ships with Document Management is installed and the company editor engine is set to TipTap. Multi-tenant aware, so every space, page, revision, permission rule, and analytics row is company-scoped. ## Installation A self-hosted install takes a few minutes. Buy the add-on, drop the plugin into your `plugins/` directory, run the migrations, and you're live. 1. 1 ### Buy the add-on Purchase the Wiki add-on from /self-hosted/pricing at $499/year per company, payable annually. 2. 2 ### Drop the plugin into your install Copy the Wiki/ folder into plugins/ on your self-hosted Orangescrum server. 3. 3 ### Register the plugin Register \`Wiki\` in src/Application.php so its routes and bootstrap load with the application. 4. 4 ### Run the database migrations Run \`bin/cake migrations migrate --plugin Wiki\` to create the space, shelf, page, revision, comment, attachment, permission, review, archival, and analytics tables, along with the search indexes. 5. 5 ### Create your first shelf and space Open the Wiki tab, create a shelf, add a space for a team or subject area, and start the page tree. 6. 6 ### Set permissions and reviewers Decide who can view, create, edit, comment, and delete in each space. Nominate the people who will review pages before they publish. 7. 7 ### Publish a portal and set archival rules Optional: mark the spaces you want readable outside the workspace and configure the portal. Add archival rules so stale pages retire on a schedule. ## Frequently Asked Questions ### How is Wiki different from the Document Management plugin? ▾ Wiki is for writing people read: handbooks, runbooks, decision records, onboarding guides. Document Management is for files you store, version, and route through approval chains for audit. They work together. A wiki page can attach a file that already lives in the Document Management repository rather than holding a second copy. ### Can two people edit the same page at the same time? ▾ Not with this add-on on its own. Wiki does not include real-time co-authoring. Pages are edited one at a time and every save creates a revision. Live co-authoring on wiki pages becomes available only when the CollabDocs component that ships with the Document Management add-on is installed and your company editor engine is set to TipTap. ### How does page approval work? ▾ You submit a page to one named reviewer with an optional note. The page moves to in review. That reviewer, or an administrator, either approves it, which publishes the page, or requests changes with a note. Every step is logged. Note that this is a single reviewer per page, not a multi-level or parallel approval chain. If you need multi-level chains, that sits in Document Management. ### Who can see a wiki space? ▾ Whoever you allow. View, create, edit, comment, and delete are separate grants. A rule can target everyone, anonymous readers, one user, a role, or a role group, and it can apply to a whole space or to a single page. An unmanaged space follows your normal workspace access. ### Can we publish pages to people outside Orangescrum? ▾ Yes. Mark a space public and it appears in the read-only docs portal, which has its own home, book, page, and search views. Readers can leave feedback on an article. Individual pages can also be shared with a link. Because you run the install, the portal is served from your own infrastructure. ### Does Wiki have an API? ▾ Yes. A REST API is available at /wiki/api/v1 covering spaces, pages, and page attachments, authenticated with API keys you create per company from the wiki settings. It is separate from the API Access add-on, which exposes projects, tasks, and the wider work hierarchy. ### What happens to pages nobody reads any more? ▾ Set archival rules and let them run on a schedule. Archived pages drop out of the day-to-day view and out of search noise, you can review everything that was archived, and you can restore any page that was archived by mistake.