luzifer/wiki
1
0
Fork 0
mirror of https://github.com/Luzifer/wiki.git synced 2024-09-18 23:23:00 +00:00
Code Issues Releases Wiki Activity

Add Usage

Browse Source 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2019-08-07 08:14:42 +02:00
parent 106a94d802
commit bbba71a9c3
Signed by: luzifer
GPG Key ID: DC2729FDD34BE99E
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -11,3 +11,21 @@
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.
## Usage
```console
# wiki --help
Usage of wiki:
--data-dir string Directory to store data to (default "./data/")
--listen string Port/IP to listen on (default ":3000")
--log-level string Log level (debug, info, warn, error, fatal) (default "info")
--version Prints current version and exits
```
To use this you can
- 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.