A simple, self-contained Wiki engine

Find a file

Magnus Hoff e4fa7ed89a Credit cmal as new contributor		2018-06-24 14:56:01 +02:00
assets	Added marker for external links (#63 )	2018-06-23 10:35:22 +02: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	Experimentally transform markdown for better presentation in full text search results	2018-01-19 16:49:26 +01:00
src	Select persistent theme per page based on title	2018-06-17 21:25:35 +02:00
templates	Apply new style to search	2018-06-17 21:16:44 +02:00
themes	Serve articles with a random theme	2018-06-16 11:24:34 +02:00
.gitignore	Ignore working file for SQLite	2017-09-21 10:07:25 +02:00
.travis.yml	Run tests in the debug build.	2018-05-21 13:50:51 +02:00
build.rs	Port to stable diesel API for user defined sqlite functions	2018-06-13 22:46:53 +02:00
Cargo.lock	Select persistent theme per page based on title	2018-06-17 21:25:35 +02:00
Cargo.toml	Select persistent theme per page based on title	2018-06-17 21:25:35 +02:00
CONTRIBUTING.md	Add CONTRIBUTING.md to help would-be contributors	2018-05-13 14:01:27 +02:00
CONTRIBUTORS.md	Credit cmal as new contributor	2018-06-24 14:56:01 +02:00
DESIGN.md	Add a document describing the design	2018-05-13 13:57:05 +02:00
LICENSE.txt	Offer Sausagewiki under GPL3	2017-09-22 16:16:40 +02:00
README.md	Promote brew install method to something one could try	2017-12-02 13:23:30 +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 (Some users are hitting rust issue #39870 with this brew formula, even though it is supposed to have 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>.