A wiki in a box - this is a backup read-only mirror of the main Github repository. https://github.com/sbrl/Pepperminty-Wiki/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Starbeamrainbowlabs ed4bda5ebc
bump version for development
1 month ago
core docs: Update apiDoc 1 year ago
docs docs: tweak language about peppermint.json 11 months ago
experiments docs: Update apiDoc 1 year ago
lantern-build-engine@094e175740 update lantern build engine 2 months ago
modules parsedown: fix templating under circumstances 2 months ago
themes theme blue: style onebox 1 year ago
.gitignore Ignore more files 3 years ago
.gitmodules Seriously reorganise stuff. Much tidier :D 4 years ago
.travis.yml Update getting a copy docs 3 years ago
Changelog.md update changelog 1 month ago
FUNDING.yml Add GitHub FUNDING definition 3 years ago
LICENSE Add license. 7 years ago
README.md README: Update todo list 1 year ago
SECURITY.md Apparently security researchers have a big problem with reading. 2 years ago
apidoc.json bump version for development 1 month ago
build.php Add MPL 2.0 short header to core code files 3 years ago
build.sh docs: Update apiDoc 1 year ago
composer.json Add luminous as a composer dependency, but it's not used yet 4 years ago
composer.lock add composer.lock file 2 months ago
download.php Add MPL 2.0 short header to core code files 3 years ago
logo.png Optimise logo 4 years ago
logo.svg Add logo 5 years ago
nightdocs.toml Use nightdocs instead of docpress. 4 years ago
pack.php Add MPL 2.0 short header to core code files 3 years ago
package-lock.json Update apidoc dependencies 1 month ago
package.json bump version for development 1 month ago
peppermint-config-info.php Add MPL 2.0 short header to core code files 3 years ago
peppermint.guiconfig.json Add initial simple oneboxing support 1 year ago
version bump version for development 1 month ago


Pepperminty Wiki Logo Pepperminty Wiki Build Status Join the chat at https://gitter.im/Pepperminty-Wiki/Lobby License: MPL-2.0 Docker pulls count

A Wiki in a box

Pepperminty Wiki is a complete wiki engine contained in a single file, inspired by @am2064's Minty Wiki. It's open source too (under MPL-2.0), so contributions are welcome!

Developed by Starbeamrainbowlabs (though contributions from others are welcome!), Pepperminty Wiki has a variety of useful (and cool!) features - such as file upload, a dynamic help page, page revision history, page tags, and more! Other amazing features are in the works too (like a theme gallery, auto update, and user watchlists), so check the release notes to see what's been added recently.

Latest Version: stable version badge pre-release version badge development version badge (Changelog)

Stay up-to-date! RSS feed GitHub Releases (Don't forget you can watch releases too)


Main Page Example


For everything you need to know (including how to get your own copy!), you probably want the documentation. It can be found here:



Real World Usage

Is your site using Pepperminty Wiki? Contact me or open an issue and tell me about where you are using Pepperminty Wiki and I'll add you to this section 😺

Pepperminty Wiki has also been mentioned in a few places:


Here's a list of things that I want to add at some point (please feel free to send a pull request and help out!).

  • Better page history (revert to revision done!, compare revisions, etc.) (#78, #79)
  • Intelligent auto-updating system that doesn't wipe your settings / module choices
  • A module registry of some sort (ideas welcome!)
  • Image maps (#103)
  • An app for Android - in progress over here!
    • Participate in the beta: https://play.google.com/apps/testing/com.sbrl.peppermint
    • Report issues here
    • An iOS app is not practical for the foreseeable future.
      • It's too expensive (dev license requires £££).
      • The ecosystem is very closed off, and I've no idea how to make an iOS app (nor do I own a device to test it on)
      • Feel free to make one yourself!
      • I'm happy to help out if you need help with Pepperminty Wiki itself (e.g. making it more machine-readable (#138))
      • Message on Gitter (see above), or open an issue on this repository.
  • User watchlists done, as of v0.21!
  • Theme gallery (#5 - coming soon in v0.20!) done, as of v0.20-beta1
  • Self-service user registration (#181)
  • Packaging for sandstorm / Nextcloud?
  • Some kinda fancier (markdown) editor maybe
  • (See more on the issue tracker!)
  • ...?

Is the feature you want to see not on this list or not implemented yet? Open an issue or send a pull request - contributions welcome!


The recommended way of running Pepperminty Wiki is with a plain PHP-enabled web server. However, a docker container is generously provided by @SQL-enwiki. You can run it like so:

docker run -d sqlatenwiki/peppermintywiki:stable


If you've found a security issue, please don't open an issue. Instead, get in touch privately - e.g. via Keybase or by email (security [at sign] starbeamrainbowlabs [replace me with a dot] com), and I'll try to respond ASAP.

If you would like to encrypt any communications with me, you can find my GPG key here.


Contributions are very welcome - both issues and pull requests! Please mention in your pull request that you release your work under the MPL-2.0 (see below).

If you're feeling that way inclined, the sponsor button at the top of the page (if you're on GitHub) will take you to my Liberapay profile if you'd like to donate to say an extra thank you :-)


Pepperminty Wiki is released under the Mozilla Public License 2.0. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.