{"id":13556979,"url":"https://github.com/sbrl/Pepperminty-Wiki","last_synced_at":"2025-04-03T11:30:21.788Z","repository":{"id":23765936,"uuid":"27140639","full_name":"sbrl/Pepperminty-Wiki","owner":"sbrl","description":"A wiki in a box","archived":false,"fork":false,"pushed_at":"2024-09-07T16:49:09.000Z","size":8936,"stargazers_count":183,"open_issues_count":34,"forks_count":22,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-10T22:31:45.315Z","etag":null,"topics":["collaborative","knowledge","lightweight","modular","php","self-hosted","selfhosted","wiki","wiki-engine"],"latest_commit_sha":null,"homepage":"https://peppermint.mooncarrot.space/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sbrl.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"CONTRIBUTING.md","funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"liberapay":"sbrl"}},"created_at":"2014-11-25T18:47:32.000Z","updated_at":"2024-09-27T12:28:57.000Z","dependencies_parsed_at":"2023-10-12T07:10:59.452Z","dependency_job_id":"e0251a06-5d28-4035-a411-a3fd31a1a0f3","html_url":"https://github.com/sbrl/Pepperminty-Wiki","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbrl%2FPepperminty-Wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbrl%2FPepperminty-Wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbrl%2FPepperminty-Wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbrl%2FPepperminty-Wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbrl","download_url":"https://codeload.github.com/sbrl/Pepperminty-Wiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246992693,"owners_count":20865865,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collaborative","knowledge","lightweight","modular","php","self-hosted","selfhosted","wiki","wiki-engine"],"created_at":"2024-08-01T12:04:06.485Z","updated_at":"2025-04-03T11:30:19.103Z","avatar_url":"https://github.com/sbrl.png","language":"PHP","funding_links":["https://liberapay.com/sbrl"],"categories":["Install from Source","PHP","self-hosted","Software","Wikis"],"sub_categories":["Wikis","Localization"],"readme":"# ![Pepperminty Wiki Logo](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/logo.png) Pepperminty Wiki [![Build Status](https://travis-ci.org/sbrl/Pepperminty-Wiki.svg?branch=master)](https://travis-ci.org/sbrl/Pepperminty-Wiki) [![Join the chat at https://gitter.im/Pepperminty-Wiki/Lobby](https://badges.gitter.im/Pepperminty-Wiki/Lobby.svg)](https://gitter.im/Pepperminty-Wiki/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge) [![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE) [![Docker pulls count](https://img.shields.io/badge/dynamic/json.svg?color=blue\u0026label=Docker%20Pulls\u0026query=%24.pull_count\u0026url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fsqlatenwiki%2Fpeppermintywiki%2F)](https://hub.docker.com/r/sqlatenwiki/peppermintywiki)\r\n\r\n\u003e A Wiki in a box\r\n\r\nPepperminty Wiki is a complete wiki engine contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/Minty-Wiki). It's open source too (under MPL-2.0), so contributions are welcome!\r\n\r\nDeveloped 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.\r\n\r\n**Latest Version:** [![stable version badge](https://img.shields.io/github/release/sbrl/Pepperminty-Wiki.svg?color=brightgreen\u0026label=stable)](https://github.com/sbrl/Pepperminty-Wiki/releases/latest) ![pre-release version badge](https://img.shields.io/github/v/release/sbrl/Pepperminty-Wiki?color=yellow\u0026include_prereleases\u0026label=pre-release) ![development version badge](https://img.shields.io/badge/dynamic/json?color=orange\u0026label=development\u0026query=latest_version\u0026url=https%3A%2F%2Fstarbeamrainbowlabs.com%2Flabs%2Fpeppermint%2Fpack.php%3Fdetermine-latest-version) ([Changelog](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md))\r\n\r\nStay up-to-date! [![RSS feed](https://img.shields.io/badge/%F0%9F%8D%84-RSS-orange)](https://github.com/sbrl/Pepperminty-Wiki/releases.atom) [![GitHub Releases](https://img.shields.io/badge/%E2%8E%94-GitHub%20Releases-black)](https://github.com/sbrl/Pepperminty-Wiki/releases) (Don't forget you can watch releases too) \r\n\r\n## Screenshot\r\n[![Main Page Example](https://i.imgur.com/5dmbKlz.png)](https://imgur.com/a/lsBc3cM)\r\n\r\n## Documentation\r\nFor everything you need to know (including how to get your own copy!), you probably want the documentation. It can be found here:\r\n\r\n**[Documentation](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/01-Welcome.html)**\r\n\r\n**[Website](https://peppermint.mooncarrot.space/)**\r\n\r\n## Real World Usage\r\n\r\n* [WikiProject Paranormal](https://www.anomalyresponse.com) - An encyclopedia of allegedly unexplained events.\r\n\r\nIs your site using Pepperminty Wiki? Contact me or [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I'll add you to this section :smiley_cat:\r\n\r\nPepperminty Wiki has also been mentioned in a few places:\r\n\r\n - [Twitter, by @flameborn](https://twitter.com/flameborn/status/1196916602953961472)\r\n - [Reddit, by u/flameborn](https://www.reddit.com/r/selfhosted/comments/d23mhx/yet_another_wiki/ezsu4rs?utm_source=share\u0026utm_medium=web2x)\r\n - @SeanFromIT has written an article describing their experience migrating from MediaWiki: [MediaWiki to Pepperminty Wiki Migration](https://feeney.mba/mediawikitopepperminty.html)\r\n\r\n## Todo\r\nHere's a list of things that I want to add at some point (please feel free to [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) and help out!).\r\n\r\n - Better page history (~~revert to revision~~ done!, compare revisions, etc.) (~~#78~~, #79)\r\n - Intelligent auto-updating system that doesn't wipe your settings / module choices\r\n - A module registry of some sort (ideas welcome!)\r\n - Image maps (#103)\r\n - An app for Android - in progress over [here](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/)!\r\n     - Participate in the beta: https://play.google.com/apps/testing/com.sbrl.peppermint\r\n     - Report issues [here](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/issues/new)\r\n     - An iOS app is not practical for the foreseeable future.\r\n         - It's too expensive (dev license requires £££).\r\n         - 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)\r\n         - Feel free to make one yourself!\r\n         - I'm happy to help out if you need help with Pepperminty Wiki itself (e.g. making it more machine-readable (#138))\r\n         - Message on Gitter (see above), or open an issue on this repository.\r\n - ~~User watchlists~~ done, as of v0.21!\r\n - ~~Theme gallery (#5 - coming soon in v0.20!)~~ done, as of v0.20-beta1\r\n - Self-service user registration (#181)\r\n - Packaging for [sandstorm](https://apps.sandstorm.io/) / [Nextcloud](https://apps.nextcloud.com/)?\r\n - Some kinda fancier (markdown) editor maybe\r\n - (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)\r\n - ...?\r\n\r\nIs the feature you want to see not on this list or not implemented yet? [Open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) or [open a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) - contributions welcome!\r\n\r\n\r\n## Docker\r\nThe recommended way of running Pepperminty Wiki is with a plain PHP-enabled web server. However, a Dockerfile is available in this repository. Instructions for building it are available on the [Getting Started page](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/04-Getting-Started.html#Docker) in the official documentation (see above).\r\n\r\n\r\n## Security\r\nIf you've found a security issue, please don't open an issue. Instead, get in touch privately - e.g. via email (`security [at sign] starbeamrainbowlabs [replace me with a dot] com`), and I'll try to respond ASAP.\r\n\r\nIf you would like to encrypt any communications with me, you can find my GPG key [here](https://starbeamrainbowlabs.com/sbrl.asc).\r\n\r\n\r\n## Contributing\r\nContributions 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).\r\n\r\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for a guide on what to expect when submitting a pull request or issue to this project.\r\n\r\nIf 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](https://liberapay.com/sbrl) if you'd like to donate to say an extra thank you :-)\r\n\r\n\r\n## License\r\nPepperminty 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](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) of the license if you're interested.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbrl%2FPepperminty-Wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbrl%2FPepperminty-Wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbrl%2FPepperminty-Wiki/lists"}