diff --git a/README.md b/README.md index ebd1574..3fcfc7a 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,34 @@ SSH honeypot with web-frontend. +## TODO + +* Fix janky ass Makefile + ## Requirements -TODO +* `go > 1.16` + +Requires a postgres database if you want data to persist through server restart. ## Build -TODO +```text +# make frontend +# make build +``` ## Install -TODO +```text +# Build and install +INSTALL_PREFIX=/ sudo make install + +# Edit config file +vim /etc/apiary/apiary.toml + +# Run +/usr/bin/apiary serve +# 2021-04-10T11:27:42.783+0200 INFO APP Starting SSH server +# 2021-04-10T11:27:42.783+0200 INFO APP Starting web server +```