surwiki/README.md

63 lines
2.5 KiB
Markdown
Raw Normal View History

2017-08-21 17:49:31 +03:00
[![Build Status](https://travis-ci.org/maghoff/sausagewiki.svg?branch=master)](https://travis-ci.org/maghoff/sausagewiki)
2017-09-22 17:16:40 +03:00
Sausagewiki is a simple, self-contained wiki engine.
2017-09-25 17:34:21 +03:00
Copyright (C) 2017 Magnus Hovland Hoff <maghoff@gmail.com>
2017-09-22 17:16:40 +03:00
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.
2017-10-29 14:16:31 +03:00
Features
========
Some features of Sausagewiki, in no particular order:
* Simple to [install and run](#install-and-run)
* No runtime dependencies
* Simple to backup, just copy the single database file whenever
2017-10-31 16:02:50 +03:00
* Can be reverse proxied behind any path without configuration
2017-10-29 14:16:31 +03:00
* Snappy, light resource usage
* Markdown syntax
2017-10-31 16:02:50 +03:00
* Plus [GitHub style table-support](https://help.github.com/articles/organizing-information-with-tables/)
2017-10-29 14:16:31 +03:00
* Without embedded HTML
* Full text search
2017-11-03 02:16:18 +03:00
* Responsive design: fits different screens as well as print
2017-10-30 00:51:19 +03:00
* Progressive enhancement: works with or without JavaScript
2017-10-29 14:16:31 +03:00
2017-09-22 17:16:40 +03:00
Install and run
===============
Sausagewiki aims to be simple to get up and running. It is distributed as a
2017-09-25 16:41:14 +03:00
single independent executable for Linux.
1. Download the latest build of `sausagewiki.xz` from <https://github.com/maghoff/sausagewiki/releases/latest>
2. Decompress: `xz -d sausagewiki.xz`
3. Set execution permission: `chmod a+x sausagewiki`
4. Run: `./sausagewiki wiki.db`
For other platforms you will presently have to build it yourself. Sausagewiki
is built like other Rust projects, with `cargo build`.
Command line arguments
----------------------
USAGE:
sausagewiki [FLAGS] [OPTIONS] <DATABASE>
2017-09-25 16:41:14 +03:00
FLAGS:
-h, --help Prints help information
2017-10-30 13:04:01 +03:00
--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
2017-09-25 16:41:14 +03:00
OPTIONS:
2017-10-30 16:59:39 +03:00
-a, --address <address> Sets the TCP address to bind to. Defaults to 127.0.0.1
-p, --port <port> Sets the listening port. Defaults to 8080
2017-09-25 16:41:14 +03:00
ARGS:
<DATABASE> Sets the database file to use
2017-09-25 17:47:13 +03:00
Sausagewiki will create an SQLite database file with the filename given in the
2017-10-30 16:59:39 +03:00
`DATABASE` parameter and open an HTTP server bound to the configured address,
`<address>:<port>`.