serv/surwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple, self-contained Wiki engine
174 commits 10 branches 153 tags 1 MiB
Rust 59.2%
HTML 28.4%
CSS 5.8%
JavaScript 5.8%
Python 0.7%
Other 0.1%
Find a file
Magnus Hoff dd97b8055c Cleanup
2017-10-30 13:06:32 +01:00
assets Attempt to stop navigation when there is an edit in progress. This fixes #16 2017-10-28 15:26:50 +02:00
libs/static_resource_derive Start tracking authors for edits. #6 2017-10-18 16:33:21 +02:00
migrations Cleanup 2017-10-30 13:06:32 +01:00
src Refactor to reuse TemporaryRedirectResource instead of ArticleRedirectResource 2017-10-30 12:56:28 +01:00
templates Refactor generation of links from slugs 2017-10-30 12:42:53 +01:00
.gitignore Ignore working file for SQLite 2017-09-21 10:07:25 +02:00
.travis.yml Strip symbols from the produced binary. 2017-10-15 13:13:07 +02:00
build.rs Add a first approximation of full text search. Issue #8 2017-10-24 16:48:16 +02:00
Cargo.lock Percent decode path segments of URL 2017-10-01 23:24:16 +02:00
Cargo.toml Sort some lists of things lexicographically 2017-10-01 23:26:57 +02: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 Prefer dashes in command line options 2017-10-30 11:04:01 +01:00

README.md

Build Status

Sausagewiki is a simple, self-contained wiki engine.

Copyright (C) 2017 Magnus Hovland Hoff maghoff@gmail.com

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
  • Simple to backup, just copy the single database file whenever
  • Snappy, light resource usage
  • Markdown syntax
    • Plus table-support
    • Without embedded HTML
  • Full text search
  • Responsive design: fits different screens
  • Progressive enhancement: works with or without JavaScript

Install and run

Sausagewiki aims to be simple to get up and running. It is distributed as a 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>

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:
    -p, --port <port>    Sets the listening port

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 127.0.0.1 and the given port number. The default port number is 8080.