Getting a Copy

Setting up your own copy of Pepperminty Wiki is easy. Since Pepperminty Wiki works on a module based system, all you need to do is choose the modules you want installed, and then configure your new installation so that it fits your needs. There are several ways to do this:

Method 1: The latest pre-built stable release

If you want a pre-built stable version, then you can use the latest release. It has a changelog that tells you what has changed since the last release, along with a pre-built version with all the latest modules.

Link: Latest Release

Method 2: Using the online downloader

Pepperminty Wiki has a downloader that you can use to select the modules you want to include in your install. The online downloader will give you the latest stable release. You can find it here.

Link: Online Downloader

Method 2.5: Using the downloader offline

You can also you the downloader offline. Simply clone this repository to your web server (or clone it locally and then upload):

git clone https://github.com/sbrl/Pepperminty-Wiki.git

Then, point your web browser at your.server.com/path/to/pepperminty/wiki/download.php.

Method 3: Building from source

Pepperminty Wiki can also be built from source (and I do this all the time when testing). Before we begin, ensure that the following dependencies are installed:

Node.js and npm
A recent version of PHP
All the PHP modules specified in the documentation

Start by cloning the repository:

git clone https://github.com/sbrl/Pepperminty-Wiki.git
cd Pepperminty-Wiki;

Then go into the modules folder and append .disabled to the names of any modules you don't want to be included (e.g. modules/page-edit.php would become modules/page-edit.php.disabled). Then follow the instructions below. The resulting file will be located at build/index.php.

If you have bash installed (i.e. Linux and macOS users), you can run that instead like this:

./build.sh setup build

The extra build is because the build script can do other things. Omit the build for a full list of tricks it has up its sleeve :D

Windows Users

The primary author of Pepperminty Wiki does not possess a Windows computer to test on. Despite this, effort is made to avoid breaking support on Windows (please open an issue if you discover any issues).

You can try initially running the above commands in git bash (installed automatically when installing git). If that doesn't work, keep reading.

Run the following commands from the root of the repository in order, adjusting them for your specific platform if required:

rm build/index.php
php build.php

Here's an explanation of what each command does:

Deletes the old index.php in the build folder that comes with the repository
Rebuilds the module index that the build scripts uses to determine what modules it should include when building, and then actually builds Pepperminty Wiki. Outputs to index.php.

Additional installation methods are being thought about. If there's a specific method you don't see here that you think should be here - let me know by opening an issue!

3.5 KiB Raw Blame History