A simple, self-contained Wiki engine

Find a file

Magnus Hoff bc0f8b8046 Restyle and refactor popup dialogs		2017-12-02 11:01:24 +01:00
assets	Restyle and refactor popup dialogs	2017-12-02 11:01:24 +01:00
deploy	Add brew formula	2017-11-29 15:45:03 +01:00
libs/codegen	Avoid copyright notice for MPL2-licensed dependencies	2017-11-14 16:14:28 +01:00
migrations	Cleanup	2017-10-30 13:06:32 +01:00
src	Inject soft hyphen into commit hash so it works better on more screens	2017-11-30 13:24:13 +01:00
templates	Restyle and refactor popup dialogs	2017-12-02 11:01:24 +01:00
.gitignore	Ignore working file for SQLite	2017-09-21 10:07:25 +02:00
.travis.yml	Avoid deep directory structure in produced tar file	2017-11-30 12:33:07 +01:00
build.rs	Use build.rs to properly trigger rebuilds when env vars change, for #44	2017-11-20 10:26:35 +01:00
Cargo.lock	Merge branch 'proper_html_handling'	2017-11-29 22:52:42 +01:00
Cargo.toml	Merge branch 'proper_html_handling'	2017-11-29 22:52:42 +01:00
CONTRIBUTORS.md	Offer Sausagewiki under GPL3	2017-09-22 16:16:40 +02:00
LICENSE.txt	Offer Sausagewiki under GPL3	2017-09-22 16:16:40 +02:00
README.md	Make it slightly clearer that the prebuilt binary is Linux only	2017-11-30 12:35:28 +01:00

README.md

Sausagewiki is a simple, self-contained wiki engine.

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.

Features

Some features of Sausagewiki, in no particular order:

Simple to install and run, no runtime dependencies
Reasonable to back up, there is only one data file
Can be reverse proxied behind any path without configuration
Snappy, light resource usage
Markdown syntax
- Plus table-support
- Without embedded HTML
Full text search
Responsive design: fits different screens as well as print
Progressive enhancement: works with or without JavaScript
Works with external authentication

Install and run

Sausagewiki aims to be simple to get up and running. It is distributed as a single independent executable for Linux:

Download the latest build of sausagewiki.tar.xz from https://github.com/maghoff/sausagewiki/releases/latest
Decompress: tar Jxf sausagewiki.tar.xz, it decompresses to the single Linux executable sausagewiki
Run: ./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 This brew fromula seems to be hitting rust issue #39870 which supposedly has been fixed.

Command line arguments

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