Pepperminty Wiki stores its settings in a JSON file called
peppermint.json, which is stored in the same directory that you put
index.php into. If it doesn't exist, it's created automatically for you when you load the page for the first time.
You can edit it directly, but most properties are configurable in a graphical interface. It can be accessed through the Edit Master Settings option in the more menu, or the
configure action (e.g.
https://wiki.example.com/?action=configure) if it doesn't appear for you.
However, some settings do still require edits to
peppermint.json directly. Examples here include:
- Editing the various navigation bars
- Configuring moderators
- Setting allowed upload file types (and mime type overrides)
- Manual HTTP/2.0 Server Push configuration
The configuration guide contains a list of all the configuration directives that Pepperminty Wiki (and all the modules included in the repository) understand. It is generated automatically from
peppermint.guiconfig.json in the repository.
User account details are currently stored as an object in
peppermint.json, under the
users special setting. Each user has their own object, in which lies their user data.
While users can change their own passwords and email addresses, you'll inevitably want to add your own users. You can do this through the brand-new user management page if you're logged in as a moderator or better. Click on the
Edit user table option on the credits page, or navigate to the
user-table action (example url:
If you're having trouble with the user table, you can also add users manually. Here's how to do it that:
peppermint.jsonin your favourite text editor.
- Create a new property on the
usersobject, whose value is an object and key is the new user's username. Use the existing users for reference.
- Hash the new user's password. This can be done in the terminal or with the
hashaction - but make sure you don't leave any traces of your passwords lying around for others to find! a. To use the
hashaction, navigate to
https://example.com/path/to/index.php?action=hash&string=my_temporary_password. Don't forget to change your password afterwards, or clear both your browser history & server logs! You could even use the demo instance I have running on my server, but I don't have a filter on my server logs :-) b. To do it through the terminal, the following one-liner should do the trick:
echo -n "some_password" | php -r 'echo(password_hash(base64_encode(hash("sha384", trim(fgets(STDIN)))), PASSWORD_DEFAULT) . "\n");'
peppermint.jsonback to disk.
The default user account details are as follows:
Please remember to change your account password! Only you are responsible for the security of your account.