1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-14 01:43:01 +00:00
Pepperminty-Wiki/README.md

82 lines
7 KiB
Markdown
Raw Normal View History

# ![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&utm_medium=badge&utm_campaign=pr-badge&utm_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&label=Docker%20Pulls&query=%24.pull_count&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fsqlatenwiki%2Fpeppermintywiki%2F)](https://hub.docker.com/r/sqlatenwiki/peppermintywiki)
2017-09-14 19:58:54 +00:00
> A Wiki in a box
2015-09-19 09:19:56 +00:00
2018-12-12 22:26:13 +00:00
Pepperminty 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!
2015-09-19 09:19:56 +00:00
2018-10-29 10:45:45 +00:00
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](https://img.shields.io/github/release/sbrl/Pepperminty-Wiki.svg?color=brightgreen&label=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&include_prereleases&label=pre-release) ![development version badge](https://img.shields.io/badge/dynamic/json?color=orange&label=development&query=latest_version&url=https%3A%2F%2Fstarbeamrainbowlabs.com%2Flabs%2Fpeppermint%2Fpack.php%3Fdetermine-latest-version) ([Changelog](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md))
2017-09-14 19:58:54 +00:00
2020-01-23 23:05:57 +00:00
Stay 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)
## Screenshot
2018-10-20 16:47:48 +00:00
[![Main Page Example](https://i.imgur.com/5dmbKlz.png)](https://imgur.com/a/lsBc3cM)
2015-09-19 09:19:56 +00:00
## Documentation
2019-01-06 11:45:21 +00:00
For everything you need to know (including how to get your own copy!), you probably want the documentation. It can be found here:
2019-07-05 20:24:51 +00:00
**[Documentation](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/01-Welcome.html)**
2018-04-07 13:44:55 +00:00
2020-05-17 12:23:27 +00:00
**[Website](https://peppermint.mooncarrot.space/)**
2015-09-19 09:19:56 +00:00
## Real World Usage
2020-08-19 13:46:00 +00:00
* [WikiProject Paranormal](https://www.anomalyresponse.com) - An encyclopedia of allegedly unexplained events.
2020-08-08 05:28:11 +00:00
Is 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:
Pepperminty Wiki has also been mentioned in a few places:
- [Twitter, by @flameborn](https://twitter.com/flameborn/status/1196916602953961472)
- [Reddit, by u/flameborn](https://www.reddit.com/r/selfhosted/comments/d23mhx/yet_another_wiki/ezsu4rs?utm_source=share&utm_medium=web2x)
- @SeanFromIT has written an article describing their experience migrating from MediaWiki: [MediaWiki to Pepperminty Wiki Migration](https://feeney.mba/mediawikitopepperminty.html)
2015-09-19 09:19:56 +00:00
## Todo
2018-12-12 19:27:05 +00:00
Here'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!).
2015-09-19 09:19:56 +00:00
2019-06-01 13:52:58 +00:00
- Better page history (~~revert to revision~~ done!, compare revisions, etc.) (~~#78~~, #79)
2018-03-18 22:02:53 +00:00
- Intelligent auto-updating system that doesn't wipe your settings / module choices
- A module registry of some sort (ideas welcome!)
- Image maps (#103)
2019-05-06 13:27:48 +00:00
- An app for Android - in progress over [here](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/)!
- Participate in the beta: https://play.google.com/apps/testing/com.sbrl.peppermint
- Report issues [here](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/issues/new)
- An iOS app is not practical for the foreseeable future.
2020-09-11 20:25:44 +00:00
- It's too expensive (dev license requires £££).
2019-05-06 13:27:48 +00:00
- 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.
2020-09-11 20:25:44 +00:00
- ~~User watchlists~~ done, as of v0.21!
2019-11-19 21:23:39 +00:00
- ~~Theme gallery (#5 - coming soon in v0.20!)~~ done, as of v0.20-beta1
2020-04-21 23:37:00 +00:00
- Self-service user registration (#181)
2020-10-01 01:17:53 +00:00
- Packaging for [sandstorm](https://apps.sandstorm.io/) / [Nextcloud](https://apps.nextcloud.com/)?
2022-02-07 03:01:14 +00:00
- Some kinda fancier (markdown) editor maybe
2018-03-18 22:02:53 +00:00
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
- ...?
2015-09-19 09:19:56 +00:00
Is 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!
2016-03-24 14:00:09 +00:00
2019-09-10 11:45:55 +00:00
2019-01-03 11:16:48 +00:00
## Docker
The 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).
2019-01-03 11:16:48 +00:00
2020-06-04 18:19:12 +00:00
2021-09-05 14:58:09 +00:00
## Security
If 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.
2021-09-05 14:58:09 +00:00
If you would like to encrypt any communications with me, you can find my GPG key [here](https://starbeamrainbowlabs.com/sbrl.asc).
2020-06-04 18:19:12 +00:00
## Contributing
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).
2024-02-01 23:47:06 +00:00
See [CONTRIBUTING.md](./CONTRIBUTING.md) for a guide on what to expect when submitting a pull request or issue to this project.
2021-04-25 16:31:08 +00:00
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](https://liberapay.com/sbrl) if you'd like to donate to say an extra thank you :-)
2020-06-04 18:19:12 +00:00
2019-01-06 11:45:21 +00:00
## License
2019-09-10 11:45:55 +00:00
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](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) of the license if you're interested.