{"id":13558393,"url":"https://github.com/maghoff/sausagewiki","last_synced_at":"2026-01-23T04:49:13.680Z","repository":{"id":24209836,"uuid":"100875840","full_name":"maghoff/sausagewiki","owner":"maghoff","description":"A simple, self-contained Wiki engine","archived":false,"fork":false,"pushed_at":"2024-08-23T19:07:32.000Z","size":601,"stargazers_count":99,"open_issues_count":33,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-04T09:37:15.706Z","etag":null,"topics":["wiki","wiki-engine"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maghoff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-20T16:57:23.000Z","updated_at":"2024-09-04T08:47:39.000Z","dependencies_parsed_at":"2024-11-04T09:31:31.033Z","dependency_job_id":"4a389b02-58e8-4277-ad88-68a14090b2ff","html_url":"https://github.com/maghoff/sausagewiki","commit_stats":null,"previous_names":[],"tags_count":153,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maghoff%2Fsausagewiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maghoff%2Fsausagewiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maghoff%2Fsausagewiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maghoff%2Fsausagewiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maghoff","download_url":"https://codeload.github.com/maghoff/sausagewiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247009547,"owners_count":20868567,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wiki","wiki-engine"],"created_at":"2024-08-01T12:04:55.657Z","updated_at":"2026-01-23T04:49:13.651Z","avatar_url":"https://github.com/maghoff.png","language":"Rust","funding_links":[],"categories":["Rust","others"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/maghoff/sausagewiki.svg?branch=master)](https://travis-ci.org/maghoff/sausagewiki)\n\nSausagewiki is a simple, self-contained wiki engine.\n\nCopyright (C) 2017 Magnus Hovland Hoff \u003cmaghoff@gmail.com\u003e\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU General Public License as published by the Free Software\nFoundation, either version 3 of the License, or (at your option) any later\nversion.\n\nFeatures\n========\nSome features of Sausagewiki, in no particular order:\n\n * Simple to [install and run](#install-and-run), no runtime dependencies\n * Reasonable to [back up](https://github.com/maghoff/sausagewiki/wiki/Backup),\n   there is only one data file\n * Can be reverse proxied behind any path without configuration\n * Snappy, light resource usage\n * Markdown syntax\n    * Plus [table-support](https://help.github.com/articles/organizing-information-with-tables/)\n    * Without embedded HTML\n * Full text search\n * Responsive design: fits different screens as well as print\n * Progressive enhancement: works with or without JavaScript\n * Works with [external authentication](https://github.com/maghoff/sausagewiki/wiki/Enabling-authentication)\n\nInstall and run\n===============\nSausagewiki aims to be simple to get up and running. It is distributed as a\nsingle independent executable for Linux:\n\n 1. Download the latest build of `sausagewiki.tar.xz` from \u003chttps://github.com/maghoff/sausagewiki/releases/latest\u003e\n 2. Decompress: `tar Jxf sausagewiki.tar.xz`, it decompresses to the single\n    Linux executable `sausagewiki`\n 3. Run: `./sausagewiki wiki.db`\n\nFor a more permanent installation, you could [install Sausagewiki as a systemd\nservice](https://github.com/maghoff/sausagewiki/wiki/System-wide-installation-with-systemd).\n\nAlternative installation methods include the following:\n\n**Build from source** with `cargo build --release`, producing the binary as\n`target/release/sausagewiki`. This requires you to have a working installation\nof [rust](https://www.rust-lang.org/en-US/).\n\n**Install with [Homebrew](https://brew.sh/)** on OS X/macOS:\n`brew install --HEAD https://raw.githubusercontent.com/maghoff/sausagewiki/master/deploy/sausagewiki.rb`\n(Some users are hitting [rust issue #39870](https://github.com/rust-lang/rust/issues/39870)\nwith this brew formula, even though it is supposed to have been fixed)\n\nCommand line arguments\n----------------------\n    USAGE:\n        sausagewiki [FLAGS] [OPTIONS] \u003cDATABASE\u003e\n\n    FLAGS:\n        -h, --help              Prints help information\n            --trust-identity    Trust the value in the X-Identity header to be an authenticated username.\n                                This only makes sense when Sausagewiki runs behind a reverse proxy which\n                                sets this header.\n        -V, --version           Prints version information\n\n    OPTIONS:\n        -a, --address \u003caddress\u003e    Sets the IP address to bind to [default: 127.0.0.1]\n        -p, --port \u003cport\u003e          Sets the listening port [default: 8080]\n\n    ARGS:\n        \u003cDATABASE\u003e    Sets the database file to use\n\nSausagewiki will create an SQLite database file with the filename given in the\n`DATABASE` parameter and open an HTTP server bound to the configured address,\n`\u003caddress\u003e:\u003cport\u003e`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaghoff%2Fsausagewiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaghoff%2Fsausagewiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaghoff%2Fsausagewiki/lists"}