selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

Pepperminty-Wiki logo

Self-host Pepperminty-Wiki

v0.24

Single-file PHP wiki engine with full-text search

BetaOpen SourceMPL-2.0
Updated6 months ago
LanguagePHP
Setup difficultyEasy
ThemeDark mode
Stars
207
Port
80 (HTTP web interface (container))
Docker
sqlatenwiki/peppermintywiki
Install with Docker Compose
Main page in light themeMain page in dark themeUser management page with photo themeRecent changes page in dark themeSearch page in light theme

What is Pepperminty-Wiki?

Pepperminty Wiki is a lightweight, self-hosted wiki engine written in PHP that runs as a single file with no database required. It stores content in flat files and uses SQLite via PDO for its search index. Key features include Markdown syntax with extensions, full-text search with advanced query syntax, page revision history, file uploads with previews, threaded comments, page tags and lists, a dynamic help page, multiple themes including a built-in dark mode that follows system preference, and a graphical user management interface. It can be installed by simply uploading the index.php file to a PHP-enabled web server, or via Docker/Docker Compose. An Android client app is available separately. The project is licensed under MPL-2.0 and developed by Starbeamrainbowlabs.

Should you self-host Pepperminty-Wiki?

Pepperminty-Wiki scores 45/100 on selfhost.directory (how scoring works) and ranks #25 of 31 in Wikis. It has 207 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is MPL-2.0-licensed and written mostly in PHP.

Its closest alternative on selfhost.directory is outline (78/100, 41 096 stars). It scores higher overall, so compare the two before you pick. See Pepperminty-Wiki vs outline side by side.

Features

  • Dynamic help page
  • File uploads
  • Flat File Storage
  • Full-Text Search
  • Markdown syntax
  • Module System
  • Page protection
  • Page tags and lists
  • Revision History
  • Single-file deployment
  • Subpages
  • Threaded comments
  • User Management

Pepperminty-Wiki README

How to install Pepperminty-Wiki

Install Pepperminty-Wiki with Docker Compose

Docker Compose, locally built pepperminty-wiki image

services: pepperminty-wiki: image: pepperminty-wiki container_name: peppermint volumes: - /absolute/path/to/peppermint.json:/srv/app/peppermint.json - /absolute/path/to/data:/srv/data

Untested Docker Compose configuration from documentation

How to configure Pepperminty-Wiki

  • anoneditsfalseWhether users who aren't logged in are allowed to edit your wiki.

    Whether users who aren't logged in are allowed to edit your wiki.

    values: true/false

  • comment_enabledtrueWhether commenting is enabled or not.

    Whether commenting is enabled or not.

    values: true/false

  • data_storage_dir"."The directory in which to store all files, except the main index.php.

    The directory in which to store all files, except the main index.php.

    values: text

  • defaultpage"Main Page"The name of the page that will act as the home page for the wiki.

    The name of the page that will act as the home page for the wiki.

    values: text

  • editingtrueWhether editing is enabled.

    Whether editing is enabled.

    values: true/false

  • enable_math_renderingtrueWhether to enable client side rendering of mathematical expressions with MathJax.

    Whether to enable client side rendering of mathematical expressions with MathJax.

    values: true/false

  • firstrun_completefalseWhether the first-run wizard has completed or not.

    Whether the first-run wizard has completed or not.

    values: true/false

  • require_login_viewfalseWhether to require that users login before they do anything else.

    Whether to require that users login before they do anything else.

    values: true/false

  • sitename"Pepperminty Wiki"Your wiki's name.

    Your wiki's name.

    values: text

  • upload_enabledtrueWhether to allow uploads to the server.

    Whether to allow uploads to the server.

    values: true/false

Pepperminty-Wiki releases & version history

FAQ

What's this about manual setup for the sitemap?

If the page-sitemap module is enabled, Pepperminty Wiki can generate an XML sitemap. You need to add a Sitemap directive to robots.txt at your domain root pointing to the sitemap URL (e.g., "Sitemap: http://wiki.example.com/path/to/index.php?action=sitemap").

How do I add a "create new page" button?

Since v0.23, Pepperminty Wiki has API support for creating a new page without knowing its name. A create new page button can be added as a navigation link to nav_links, nav_links_extra, or nav_links_bottom in peppermint.json with the link "index.php?action=edit&unknownpagename=yes".

More in Wikis

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…