42 lines
2.7 KiB
Markdown
42 lines
2.7 KiB
Markdown
# 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](https://github.com/sbrl/Pepperminty-Wiki/releases/latest)
|
|
|
|
## Method 2: The pre-built version from the repository
|
|
If you're feeling lazy, you can grab the bleeding-edge version from this repository, which comes with all the latest modules. You can get it [here](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/build/index.php).
|
|
|
|
**Link:** [index.php](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/build/index.php)
|
|
|
|
## Method 3: 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](https://starbeamrainbowlabs.com/labs/peppermint/download.php)
|
|
|
|
## Method 3.5: Using the downloader offline
|
|
You can also you the downloader offline. Simply clone this repository to your web server and then point your web browser at `your.server.com/path/to/pepperminty/wiki/download.php`.
|
|
|
|
## Method 4: Building from source
|
|
Pepperminty Wiki can also be built from source (and I do this all the time when testing). Start by cloning the repository. 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 for your platform below. The resulting file will be located at `build/index.php`.
|
|
|
|
### Windows
|
|
Simply run the `build.bat` script in the root of the repository. It will handle everything for you.
|
|
|
|
### Linux and Everyone Else
|
|
Run the following commands from the root of the repository in order, adjusting them for your specific platform (these are for a standard Ubuntu Server install):
|
|
|
|
```bash
|
|
rm build/index.php
|
|
php rebuild_module_index.php
|
|
php build.php
|
|
```
|
|
|
|
These commands are also in `build.sh`. You can run that if you want. Here's an explanation of what each command does:
|
|
|
|
1. Deletes the old `index.php` in the build folder that comes with the repository
|
|
2. Rebuilds the module index that the build scripts uses to determine what modules it should include when building
|
|
3. Actually builds Pepperminty Wiki. Outputs to `index.php`.
|