commit 2f09adb0857f3df562bcfe0d9634cf24563f8dcd from: Omar Polo date: Mon Jan 25 14:52:19 2021 UTC readme addition commit - 71cf39757d8046b54039dcf7061861ed48cda6e3 commit + 2f09adb0857f3df562bcfe0d9634cf24563f8dcd blob - 6675b637087fe710371ab5eaf49f840420bf9924 blob + 56cca18eb8dffdc6d0615218d2cfa9e711fd66d3 --- README.md +++ README.md @@ -7,12 +7,23 @@ configuration, so it's well suited for local developme same time has a configuration file flexible enough to meet the requirements of most capsules. -gmid was initially written to serve static files, but can also +It was initially written to serve static files, but can also optionally execute CGI scripts. It was also written with security in mind: on Linux, FreeBSD and OpenBSD is sandboxed via `seccomp(2)`, `capsicum(4)`and `pledge(2)`+`unveil(2)` respectively. +gmid can be used from the command line to serve local directories + # serve the directory docs + gmid docs + +or you can pass a configuration file and have access to every feature + + gmid -c /etc/gmid.conf + +Please consult the [manpage](gmid.1) for more information. + + ## Features - IRI support (RFC3987) @@ -21,6 +32,10 @@ mind: on Linux, FreeBSD and OpenBSD is sandboxed via ` - (very) low memory footprint - small codebase, easily hackable - virtual hosts + - rules per-location + - directory listings + - mime types configurable + - index file configurable - sandboxed by default on OpenBSD, Linux and FreeBSD - chroot support