A simple, self-contained Wiki engine
Sausagewiki is a simple, self-contained wiki engine.
Copyright (C) 2017 Magnus Hovland Hoff [email protected]
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Some features of Sausagewiki, in no particular order:
Sausagewiki aims to be simple to get up and running. It is distributed as a single independent executable for Linux:
sausagewiki.tar.xz
from https://github.com/maghoff/sausagewiki/releases/latest
tar Jxf sausagewiki.tar.xz
, it decompresses to the single
Linux executable sausagewiki
./sausagewiki wiki.db
For a more permanent installation, you could install Sausagewiki as a systemd service.
Alternative installation methods include the following:
Build from source with cargo build --release
, producing the binary as
target/release/sausagewiki
. This requires you to have a working installation
of rust.
Install with Homebrew on OS X/macOS:
brew install --HEAD https://raw.githubusercontent.com/maghoff/sausagewiki/master/deploy/sausagewiki.rb
(Some users are hitting rust issue #39870
with this brew formula, even though it is supposed to have been fixed)
USAGE:
sausagewiki [FLAGS] [OPTIONS] <DATABASE>
FLAGS:
-h, --help Prints help information
--trust-identity Trust the value in the X-Identity header to be an authenticated username.
This only makes sense when Sausagewiki runs behind a reverse proxy which
sets this header.
-V, --version Prints version information
OPTIONS:
-a, --address <address> Sets the IP address to bind to [default: 127.0.0.1]
-p, --port <port> Sets the listening port [default: 8080]
ARGS:
<DATABASE> Sets the database file to use
Sausagewiki will create an SQLite database file with the filename given in the
DATABASE
parameter and open an HTTP server bound to the configured address,
<address>:<port>
.