From 7798a8d1132128443cf616eb908dce8affb6e207 Mon Sep 17 00:00:00 2001 From: Till Hoeppner Date: Sun, 30 Nov 2014 22:30:32 +0100 Subject: More information in README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index b1c02d4..fe34ab0 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,45 @@ sersve [![Build Status](https://travis-ci.org/hoeppnertill/sersve.svg)](https:// ====== A simple directory server. It works for my own purposes so far, but feel free to try or contribute. + +[Relevant blog article.](http://till.hoeppner.ws/2014/11/30/Introducing-sersve-a-directory-server-in-Rust-with-Iron/) + +## Build + +```bash +git clone https://github.com/hoeppnertill/sersve.git +cd sersve +cargo build --release # leave off --release if impatient +target/release/sersve # target/sersve respectively +# You can now visit `localhost:8080` in a browser +``` + +## Options + +``` +Usage: target/release/sersve [options] +A minimal directory server, written in Rust with Iron. +Options: + -c --config NAME set config file name + -a --address HOST the address to bind to + -p --port PORT the port to serve + -r --root ROOT the uppermost directory to serve + -f --filter REGEX a regular expression to filter the filenames + -s --size BYTES the maximum size of a file that will be served + -t --template TEMPLATE + a mustache template to use for rendering + -h --help print this help menu +``` + +## Configuration format + +```json +{ + "address": "0.0.0.0", + "port": 8080, + "root": "/home/", + "filter": "^[^\\.]+$", + "template": "{{title}}

{{title}}

{{#content}} {{/content}}
NameSize
{{name}} {{size}}
", + "size": 10485760 +} +``` -- cgit v1.2.3