Install Frappe Wiki

You can use Frappe Wiki on Frappe Cloud, or host it yourself with Frappe Pilot.

Supported versions

This guide is for Frappe Wiki v3. If you use Wiki v2, see Migrate from Wiki v2.

Frappe Cloud (recommended)

1. Open the Wiki app on the Frappe Cloud Marketplace.
2. Follow the steps to add the app to a new or existing site.

Frappe Cloud does the installation, upgrades and backups for you.

Self-hosting

Use Frappe Pilot to host Frappe Wiki on your own server. Pilot installs and manages benches and sites, and sets up production for you.

1. Install Pilot and create a bench. Follow the steps in the Pilot README. In the commands below, put the name of your bench in place of <bench>.

2. Get the app. version-3 is the stable branch of Wiki v3:

   pilot -b <bench> get-app https://github.com/frappe/wiki --branch version-3
   

3. If you do not have a site yet, create one. Put your site name in place of <site>:

   pilot -b <bench> new-site <site>
   

4. Install the app on the site:

   pilot -b <bench> install-app <site> wiki
   

To serve the site on a domain with TLS, see the production steps in the Pilot README.

Open the app

After the installation, open /wiki-app on your site, for example https://example.com/wiki-app. Sign in if the site asks you to.

The installation creates one space, Wiki, at /docs. It has one page, Welcome to Frappe Wiki. You can rename this space, or delete it and make your own.

Users with the Wiki Manager role also see Wiki on the apps screen of the site.

Each user that you add after the installation gets the Wiki User role, so they can open the app. Users that existed before need the role too. To give other people more access, see Roles and permissions.

Next steps

• Find your way around
• Quick start: Create a space