README.md

README.md

@@ -1,6 +1,41 @@
 # serveg
-Small HTTP/1.1 file server. Meant to run behind a reverse proxy that handles TLS.
+Small HTTP/1.1 file server. Meant to run behind a reverse proxy that handles TLS (see [Caddy](#caddy)).
-- download, upload
+
-- per-directory passwords
+## Features:
-- own http implementation, not "net/http".
+- upload and download files
+- per-directory passwords (read more in example config)
 - generates html pages for directories
+- own http implementation, not "net/http"
+
+## Dependencies
+- [BurntSushi/toml](https://github.com/BurntSushi/toml) - toml 1.1.0 parser
+- [daviddengcn/go-colortext](https://github.com/daviddengcn/go-colortext) - print colored text (linux/windows)
+
+## Build
+```sh
+make build
+```
+
+## Run
+
+```sh
+cp serveg.example.toml serveg.toml # edit shares and passwords
+bin/servegp         # reads ./serveg.toml
+# or
+bin/servegp -config /etc/serveg/serveg.toml
+```
+
+## Caddy
+
+```
+files.example.com {
+    request_body {
+        max_size 4GB
+    }
+    reverse_proxy 127.0.0.1:8080 {
+        transport http {
+            versions 1.1
+        }
+    }
+}
+```