Installing
Any PHP (5.4+) enabled web server will do. You need to make sure that it has session support though, as they are used to allow users to log in. If your php server does not have session support, you will know about it quite quickly since it won't remember you logging in.
Information about configuring PHP sessions can be found here: https://php.net/manual/en/session.installation.php
You must also make sure that PHP can write to the folder that you are going to install Pepperminty Wiki in.
More detailed information about installing Pepperminty Wiki can be found on this repository's wiki (CATION: OUTDATED - SEE BELOW).
Pepperminty Wiki is made up of a single file: index.php. You can get it in 3 different ways:
The fastest way is to download the index.php file located in the repository. This is the development release, and should mostly work. It comes pre-packaged with all the latest modules, too!
The repository also has (semi) regular releases that are (mostly) guaranteed to be stable. You can get the latest one from the releases page. The latest release comes with all the latest plugin releases too!
If you want to choose which modules you want in your wiki, you can use the downloader. This lets you choose the modules you want - the system will automatically build the a customised copy just for you! The downloader will be updated on each release (if it hasn't been upadted please open an issue).
You can find it here: Pepperminty Wiki Downloader
If you want to build Pepperminty Wiki from source, you can do this in 2 ways. Start by cloning this repository, and then follow the instructions below. If you don't have git installed, simply click the "Download Zip" button to the right.
- Delete the modules you don't want installed in the
modules/folder - Run
php rebuild_module_index.php - Delete
index.phpif it exists - Run
php build.php
If you are on Windows, you can run the build.bat batch file I wrote instead of steps 2-4.
- Start a local web server in the root of the cloned repository
- Navigate to
download.phpin your web browser on the local web server - Tick the boxes of the modules you want
- Click the download button
To configure it, open your downloaded copy of index.php in your favourite editor - the settings can be configured at the top of the file. There are extensive comments that explain what each option does. Make sure that you change the allowed usernames and passwords! If you need more help, don't hesitate to open an issue on this repository or contact me.
Make sure you don't edit anything below this:
///////////////////////////////////////////////////////////////////////////////////////////////
/////////////// Do not edit below this line unless you know what you are doing! ///////////////
///////////////////////////////////////////////////////////////////////////////////////////////The above is the dividing line where the settings stop and the actual code for the wiki itself starts. Don't edit the dividing line itself either, as the automatic update looks for it when you ask it to update the wiki for you.