Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maghoff/sausagewiki
A simple, self-contained Wiki engine
https://github.com/maghoff/sausagewiki
wiki wiki-engine
Last synced: 5 days ago
JSON representation
A simple, self-contained Wiki engine
- Host: GitHub
- URL: https://github.com/maghoff/sausagewiki
- Owner: maghoff
- License: gpl-3.0
- Created: 2017-08-20T16:57:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T16:44:09.000Z (about 1 year ago)
- Last Synced: 2024-08-02T12:49:35.307Z (3 months ago)
- Topics: wiki, wiki-engine
- Language: Rust
- Homepage:
- Size: 570 KB
- Stars: 98
- Watchers: 5
- Forks: 5
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - maghoff/sausagewiki - A simple, self-contained Wiki engine (others)
README
[![Build Status](https://travis-ci.org/maghoff/sausagewiki.svg?branch=master)](https://travis-ci.org/maghoff/sausagewiki)
Sausagewiki is a simple, self-contained wiki engine.
Copyright (C) 2017 Magnus Hovland Hoff
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](#install-and-run), no runtime dependencies
* Reasonable to [back up](https://github.com/maghoff/sausagewiki/wiki/Backup),
there is only one data file
* Can be reverse proxied behind any path without configuration
* Snappy, light resource usage
* Markdown syntax
* Plus [table-support](https://help.github.com/articles/organizing-information-with-tables/)
* 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](https://github.com/maghoff/sausagewiki/wiki/Enabling-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
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](https://github.com/maghoff/sausagewiki/wiki/System-wide-installation-with-systemd).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](https://www.rust-lang.org/en-US/).**Install with [Homebrew](https://brew.sh/)** on OS X/macOS:
`brew install --HEAD https://raw.githubusercontent.com/maghoff/sausagewiki/master/deploy/sausagewiki.rb`
(Some users are hitting [rust issue #39870](https://github.com/rust-lang/rust/issues/39870)
with this brew formula, even though it is supposed to have been fixed)Command line arguments
----------------------
USAGE:
sausagewiki [FLAGS] [OPTIONS]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 informationOPTIONS:
Sets the IP address to bind to [default: 127.0.0.1]
-a, --address
-p, --port Sets the listening port [default: 8080]ARGS:
Sets the database file to useSausagewiki will create an SQLite database file with the filename given in the
:`.
`DATABASE` parameter and open an HTTP server bound to the configured address,
`