A simple, self-contained Wiki engine

Find a file

Johannes Hoff 5325d563aa Build for both x86_64 and ARM		2023-09-27 18:40:14 +02:00
assets	Completely disable setting focus.	2018-10-08 07:53:41 +02:00
deploy	Add brew formula	2017-11-29 15:45:03 +01:00
libs/codegen	Addressed many cargo clippy complaints	2022-04-03 22:09:36 +02:00
migrations	Store theme explicitly in database. Propagate theme both ways between db and frontend	2018-09-23 22:38:18 +02:00
src	Remove some redundant "extern crate" statements	2022-04-03 22:21:04 +02:00
templates	Bugfix. Anonymous edits would have a stray period.	2018-10-07 13:54:09 +02:00
themes	Iterate on themes	2018-07-21 11:54:03 +02:00
.gitignore	Ignore working file for SQLite	2017-09-21 10:07:25 +02:00
.travis.yml	Build for both x86_64 and ARM	2023-09-27 18:40:14 +02:00
build.rs	Upgrade quote	2022-04-03 22:16:45 +02:00
Cargo.lock	Update bart dependency, which depended on a yanked crate version.	2023-06-21 21:59:17 +02:00
Cargo.toml	Update bart dependency, which depended on a yanked crate version.	2023-06-21 21:59:17 +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	Inconsequential change to trigger CI pipeline	2018-10-01 10:03:24 +02: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>.