diff --git a/README.md b/README.md index edae4d6..0ddae39 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # komodo-agent -Komodo agent is used to integrate additional servers with komodo. \ No newline at end of file +Komodo agent is used to integrate additional servers with komodo. + +## Usage + +1. Clone the repository or copy the `compose.yaml` file onto the server that you +would like to install the agent on. + +2. Generate the `.env` file (or run `source ./bootstrap.sh`). + +3. Start the agent `sudo docker compose --env-file .env up -d` (or run `source + ./start.sh`) + + diff --git a/bootstrap.sh b/bootstrap.sh new file mode 100644 index 0000000..9495cd8 --- /dev/null +++ b/bootstrap.sh @@ -0,0 +1,4 @@ +#/bin/sh + +cp example.env .env +echo "Open the .env file and update the environment variables." diff --git a/start.sh b/start.sh new file mode 100644 index 0000000..125f1c4 --- /dev/null +++ b/start.sh @@ -0,0 +1,3 @@ +#!/bin/sh + +sudo docker compose --env-file .env up -d