luzifer/wiki
1
0
Fork 0
mirror of https://github.com/Luzifer/wiki.git synced 2024-12-20 10:31:18 +00:00
Code Issues Releases Wiki Activity
File-based Wiki implementation with web-editing capabilities and a Git backed storage
28 commits 1 branch 8 tags 4.7 MiB
Go 40.6%
Vue 29.7%
CSS 7.5%
Shell 5.9%
JavaScript 5.5%
Other 10.8%
Find a file
Knut Ahlers 2c72000607
prepare release v0.3.1
2020-10-20 21:11:17 +02:00
default_files Move default files, add navigation default 2019-08-15 22:39:05 +02:00
frontend Generate: Update bundled JS 2020-07-31 23:15:14 +02:00
src Fix: Update node deps 2020-10-20 21:10:54 +02:00
.gitignore Initial implementation 2019-08-05 00:42:41 +02:00
.repo-runner.yaml Add build files 2019-08-07 07:40:07 +02:00
assets.go Generate: Update bundled JS 2020-07-31 23:15:14 +02:00
docker-entrypoint.sh Add dockerized version 2019-08-07 08:01:59 +02:00
Dockerfile Add dockerized version 2019-08-07 08:01:59 +02:00
go.mod Implement git integration for history 2019-08-07 07:23:11 +02:00
go.sum Fix missing entry for Windows compile 2020-07-31 23:30:03 +02:00
History.md prepare release v0.3.1 2020-10-20 21:11:17 +02:00
LICENSE Add META 2019-08-07 07:31:56 +02:00
main.go Add support for custom author configuration through auth proxy 2020-08-04 17:36:05 +02:00
Makefile npm update & audit fix & dedupe 2020-07-31 23:13:43 +02:00
README.md Add support for custom author configuration through auth proxy 2020-08-04 17:36:05 +02:00
storage.go Add support for custom author configuration through auth proxy 2020-08-04 17:36:05 +02:00
storage_test.go Initial implementation 2019-08-05 00:42:41 +02:00

README.md

Go Report Card

Luzifer / wiki

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.

Usage

# wiki --help
Usage of wiki:
      --author-email-header string   Header to use as Author email
      --author-name-header string    Header to use as Author name
      --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
  • pull the Docker image
  • 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.

Setting the author name of the commit

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) 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.