serv/surwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple, self-contained Wiki engine
360 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 Hovland Hoff 17c23da9bf Better scroll handling when toggling editing. 
It will now retain the scroll position relative to the full document height when entering and leaving editing mode. This places the viewport closer to the contents you were watching. This is likely less disorienting
2018-10-01 09:01:27 +02:00
assets Better scroll handling when toggling editing. 2018-10-01 09:01:27 +02:00
deploy Add brew formula 2017-11-29 15:45:03 +01:00
libs/codegen Refactor handling of generated unique names for resources 2018-06-24 23:00:35 +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 Include theme in response when creating new article. 2018-09-30 22:29:37 +02:00
templates Centralize handling of form elements state handling. 2018-09-30 22:30:52 +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 Avoid storing build cache in travis, 2018-09-24 18:30:17 +02:00
build.rs Allow build.rs to figure out the correct database schema 2018-09-23 21:39:54 +02:00
Cargo.lock Update serde_urlencoded dependency for bugfix 2018-09-23 21:39:09 +02:00
Cargo.toml Update serde_urlencoded dependency for bugfix 2018-09-23 21:39:09 +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

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
  • 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
  • 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:

  1. Download the latest build of sausagewiki.tar.xz from https://github.com/maghoff/sausagewiki/releases/latest
  2. Decompress: tar Jxf sausagewiki.tar.xz, it decompresses to the single Linux executable sausagewiki
  3. 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>.