diff --git a/README.md b/README.md index 5d718e8..2c05b22 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ There are several ways to install thalos, via package manager, downloading a pre * [Debian/Ubuntu based (apt)](docs/install/debian.md) -## Manually using prebuilt binaries +### Manually + +#### Bundled binaries You can get the latest archive package [here](https://github.com/eosswedenorg/thalos/releases/latest) @@ -46,7 +48,7 @@ curl -Ls https://github.com/eosswedenorg/thalos/releases/download//thal **NOTE**: Using curl command above, the files are extracted into the `thalos` subdirectory of the current directory where the command is run. -## From source +#### From source Follow the instructions from the [Compiling](#compiling) section. @@ -56,6 +58,46 @@ After building the binary you can install it along with basic config file and st ./install.sh /path/to/your/directory/of/choice ``` +### Configure and run the server + +The configuration file is located at `config.yml` in the installed directory and contains an example configuration with extensive documentation. Below are the essential fields that you need to modify. You can adjust the settings according to your preferences. + +```yml +name: MyShipReader +api: "http://api.example.com:8888" + +ship: + url: "ws://ship.example.com:8080" +``` + +Start the server using the `start.sh` script. + +```sh +./start.sh +``` + +The logs can be found in `logs` directory (unless specified otherwise in the configuration). + +Stopping the server again is as simple as running. + +```sh +./stop.sh +``` + +### Starting Manually + +If desired, Thalos can also be started manually for quick configuration testing. + +```sh +./bin/thalos-server +``` + +or if you want to specify another config file then the default + +```sh +./bin/thalos-server --config /path/to/thalos.yml +``` + ## Runtime dependencies Make sure `redis` is installed as thalos uses it for both cache and message broker.