From 02ce76bc759236151d210e0404990d01a46c7092 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 22 Aug 2023 07:46:06 +0200 Subject: [PATCH] Cleanup README and refer to the documentation site. --- README.md | 85 +------------------------------------------------------ 1 file changed, 1 insertion(+), 84 deletions(-) diff --git a/README.md b/README.md index 2c05b22..aa3ac84 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,7 @@ Thalos is a application that makes it easy for users to stream blockchain data from an Antelope SHIP node. -It handles all the technical stuff for you: - - * Decoding of antelope's binary format. - * Websocket connection (with reconnection) - * Decoding of action data according to contract ABI - -And then sends the data over redis in plain json (or other popular formats if you want!) +Consult the [documentation](https://thalos.waxsweden.org/docs) for more information. ## Compiling @@ -25,83 +19,6 @@ or using go directly if you dont have make installed. ```shell $ go build -o build/thalos-server cmd/main/main.go ``` - -## Install - -There are several ways to install thalos, via package manager, downloading a pre-built binary or building directly from source. - -### Package Managers - -* [Debian/Ubuntu based (apt)](docs/install/debian.md) - -### Manually - -#### Bundled binaries - -You can get the latest archive package [here](https://github.com/eosswedenorg/thalos/releases/latest) - -Simply download using your webbrowser or via curl: - -```sh -curl -Ls https://github.com/eosswedenorg/thalos/releases/download//thalos-server--linux-amd64.tar.gz | tar -z --one-top-level=thalos -xvf - -``` - -**NOTE**: Using curl command above, the files are extracted into the `thalos` subdirectory of the current directory where the command is run. - -#### From source - -Follow the instructions from the [Compiling](#compiling) section. - -After building the binary you can install it along with basic config file and start/stop scripts using `install.sh` - -```shell -./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. - ## Author Henrik Hautakoski - [henrik@eossweden.org](mailto:henrik@eossweden.org) \ No newline at end of file