apiary/README.md

47 lines
860 B
Markdown
Raw Normal View History

2021-04-10 05:58:01 +00:00
# Apiary
SSH honeypot with web-frontend.
2021-04-10 09:29:55 +00:00
## TODO
* Fix janky ass Makefile
2021-04-10 05:58:01 +00:00
## Requirements
2021-04-10 09:44:38 +00:00
* `go >= 1.16`
2021-04-10 09:29:55 +00:00
Requires a postgres database if you want data to persist through server restart.
2021-04-10 05:58:01 +00:00
## Build
2021-04-10 09:29:55 +00:00
```text
# make frontend
# make build
```
2021-04-10 05:58:01 +00:00
## Install
2021-04-10 09:29:55 +00:00
```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
```
## Development
Run postgres-tests by running a postgres container:
```text
podman run -d -q -e POSTGRES_PASSWORD=apiary -e POSTGRES_USER=apiary -e POSTGRES_DB=apiary --rm --name apiary-test-db -p5432:5432 postgres:latest
export APIARY_TEST_POSTGRES_DSN="postgresql://apiary:apiary@localhost/apiary"
go test ./...
```