eosswedenorg/thalos
1
0
Fork 0
mirror of https://github.com/eosswedenorg/thalos synced 2026-06-17 04:30:03 +02:00
Code Releases Activity

Cleanup README and refer to the documentation site.

Browse source
This commit is contained in:
Henrik Hautakoski 2023-08-22 07:46:06 +02:00
parent fb9110ec64
commit 02ce76bc75
1 changed files with 1 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

85
README.md
View file

@ -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/<version>/thalos-server-<version>-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)