README
¶
knut - a tiny webserver which throws (file-) trees through a window
I want to make 'folder1' and 'file2' of my home directory public, without serving both resources on different http-ports, without exposing the rest of my $HOME, without any copying of the files or folders to another place.
I also want to map resources to URIs, adhoc, without any complex config files or any other voodoo.
And sometimes it's quite handy to just tell someone to POST stuff to a httpd-resource.
Usage
knut [opts] uri:folder [mapping2] [mapping3] [...]
Sample:
knut /:. /ding.txt:/tmp/dong.txt
Mapping Format:
/:. - list contents of current directory via "/"
/uri:folder - list contents of "folder" via "/uri"
/uri:file - serve "file" via "/uri"
/uri:@text - respond with "text" at "/uri"
30x/uri:location - respond with 301 at "/uri"
@/upload:folder - accept multipart encoded data via POST at "/upload"
and store it inside "folder". A simple upload form
is rendered on GET.
/c.tgz:tar+gz://./ - creates a (gzipped) tarball from the current
directory and serves it via "/c.tgz"
/z.zip:zip://./ - creates a zip files from the current directory
and serves it via "/z.zip"
/z.zip:zipfs://a.zip - list and servce the content of the entries of an
existing "z.zip" via the "/z.zip": consider a file
"example.txt" inside "z.zip", it will be directly
available via "/z.zip/example.txt"
/uri:http://1.2.3.4/ - creates a reverse proxy and forwards requests to
/uri to the given http-host
/uri:git://folder/ - serves files via "git http-backend"
/uri:cgit://path/to/dir - serves git-repos via "cgit"
/uri:myip:// - serves a "myip" endpoint
Options:
-auth="": use 'name:password' to require
-bind=":8080": address to bind to
-compress=true: handle "Accept-Encoding" = "gzip,deflate"
-log=true: log requests to stdout
-server-id="knut/1.0": add "Server: <val-here>" to the response
-tls-cert="": use given cert to start tls
-tls-key="": use given key to start tls
-tls-onetime=false: use a onetime-in-memory cert+key to drive tls
Build & Installing
The only requirement to build knut: A working go-compiler. Check http://golang.org for more information on how to setup one. If you have a working golang-compiler:
$> export GOPATH=`pwd`
$> go get github.com/mgumz/knut
$> ./bin/knut -h
If you need to install something:
$> cp ./bin/knut /path/to/final/place
The name
knut or "St. Knut's day" is an annually celebrated festival in sweden / finland on 13 January. It marks the end of christmas. Among other activities the christmas trees are disposed. Get inspired:
Directories