diff --git a/README.md b/README.md new file mode 100644 index 0000000..29f6ab9 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# keybase-jitsi-bot +A bot for Keybase that start Jitsi meetings + +This package requires the keybase binary installed on your system, and works on linux, macOS, and Windows 10 + +#### Tested on: + - Ubuntu Latest + - macOS Latest + - Windows Latest + +## Running on the command line: +#### Installation: + - `git clone https://github.com/haukened/keybase-jitsi-bot.git` + - `cd keybase-jitsi-bot` + - `go get -u ./...` + - `go build` + - `go install` + +(The typical `go install github.com/haukened/boom-bot` may or may not work due to experimental branch dependencies, and the above proceedure always works even though its longer). +#### Running: +``` + -debug + enables command debugging +``` + +#### Example: +`jitsi-bot --debug` + +## Running in the docker container: +#### Pulling the container: + +`docker pull haukeness/keybase-jitsi-bot` + +#### Running the container: +You need to set ENV vars instead of passing command line flags: + +Required by keybase: (Must set all of these) + - `KEYBASE_USERNAME=foo` + - `KEYBASE_PAPERKEY="bar baz ..."` + - `KEYBASE_SERVICE=1` + +Required by this package: (Set the values you feel like, if you don't set them they won't be used) + - `BOT_DEBUG=true` + +#### Example: +`docker run --name myJitsi --rm -d -e KEYBASE_USERNAME=FOO -e KEYBASE_PAPERKEY="bar baz ..." -e KEYBASE_SERVICE=1 -e BOT_DEBUG=true haukeness/keybase-jitsi-bot`