`wiki` is a small file-based Wiki implementation with web-editing capabilities and a Git backed storage for history of pages.
The goal of this project was to have a small application to be deployed without any dependencies to open a Wiki for note taking or documentation purpose.
The software itself has no concept of users or authentication and is held as simple as possible. Saved pages are stored as plain Markdown file onto the local disk inside a Git repository which on the one hand can be used to backup the state (just add a remote and set up a cron to push changes) and on the other hand to recover contents if someone deleted contents from a page.
- download pre-build binaries from the [releases](https://github.com/Luzifer/wiki/releases)
- pull the [Docker image](https://hub.docker.com/r/luzifer/wiki)
- or `go get -u github.com/Luzifer/wiki` the project
Given you've used the binary you can now just execute `./wiki` and go to `http://localhost:3000`. Everything you save will be stored in the `./data` directory.
If you've put the wiki behind an auth-proxy which is able to set headers containing the username / email of the authenticated user (for example nginx with [nginx-sso](https://github.com/Luzifer/nginx-sso)) you can specify the `--author-email-header` and/or `--author-name-header` and provide the header names you've used there. These values will then be used as the author of the commit while the committer will still be the wiki-user.
