Skip to content

Repository files navigation

KWiki - a lightweight Git-backed wiki

Русская версия

Latest Linux build: download kwiki.

chmod +x kwiki

Server

./kwiki -data ./data -addr :8000 -pepper 'long-secret' -secure
Flag Default Purpose
-data ./data main storage
-addr :8000 HTTP address
-pepper empty password hash secret, same as for user add and user passwd
-secure off secure cookie and strict transport header; requires HTTPS
-home README.md branch root page
-lang ru default UI language (ru, en)

Users

Set the password with -password. If the flag is empty, it is read hidden from the terminal.

The first user becomes an administrator. -admin also makes later users administrators.

./kwiki user add -data ./data -email [email protected] -name KWiki -surname KWiki -password 'S3cure-Wiki-Pass' -pepper 'long-secret' -admin

./kwiki user passwd -data ./data -email [email protected] -password 'N3w-Wiki-Password' -pepper 'long-secret'

./kwiki user block -data ./data -email [email protected]

./kwiki user unblock -data ./data -email [email protected]

./kwiki user delete -data ./data -email [email protected]
Command Flags
user add -data -email -name -surname -password -pepper -admin
user passwd -data -email -password -pepper
user block -data -email
user unblock -data -email
user delete -data -email

-pepper for user add, user passwd, and the server must match. Otherwise existing passwords will not work.


Docker

docker build -t kwiki .
docker run -p 8000:8000 -v kwiki-data:/var/lib/data kwiki -pepper 'long-secret'

Data lives in the kwiki-data volume. First user:

docker run --rm -v kwiki-data:/var/lib/data kwiki user add -data ./data -email [email protected] -name KWiki -surname KWiki -password 'S3cure-Wiki-Pass' -pepper 'long-secret' -admin

Build from source

Requires Go 1.27, Node.js 22, and Yarn 1.22.

yarn
yarn build:css
go build -o build/kwiki ./cmd/kwiki

yarn build:css must run before go build

About

KWiki - a lightweight Git-backed wiki

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages