eosswedenorg/thalos-docs
1
0
Fork 0
mirror of https://github.com/eosswedenorg/thalos-docs synced 2026-07-04 12:03:42 +02:00
Code Releases Activity

docs/configuration.md: fix links to datatypes

Browse source
This commit is contained in:
Henrik Hautakoski 2024-06-27 14:12:28 +02:00
parent ab1f9460af
commit 90e326422a
1 changed files with 26 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

51
docs/configuration.md
View file

@ -12,62 +12,62 @@ ship:
### General ### General
`name` (`string`) - Name of the talos node. `name` ([`string`](#string)) - Name of the talos node.
`api` (`string`) - Nodeos API Endpoint. `api` ([`string`](#string)) - Nodeos API Endpoint.
`message_codec` (`string`) default: `json` `message_codec` ([`string`](#string)) default: `json`
What codec thalos should use when pushing out messages to redis. What codec thalos should use when pushing out messages to redis.
### Ship ### Ship
`ship.url` (`string`) - Url to the nodeos node. `ship.url` ([`string`](#string)) - Url to the nodeos node.
`ship.chain` (`string`) `ship.chain` ([`string`](#string))
name of the chain, if not defined thalos will use the chain id reported from `api`. name of the chain, if not defined thalos will use the chain id reported from `api`.
This value (or chain_id if undefined) is prepended to channel names, to allow for multiple thalos instances This value (or chain_id if undefined) is prepended to channel names, to allow for multiple thalos instances
to run to run
`ship.irreversible_only` (`boolean`) `ship.irreversible_only` ([`boolean`](#boolean))
If `true`, the ship node will only send transactions once they are considered irreversible. If `true`, the ship node will only send transactions once they are considered irreversible.
If `false` the transactions are posted as soon as possible. If `false` the transactions are posted as soon as possible.
`ship.start_block_num` (`integer`) `ship.start_block_num` ([`integer`](#integer))
Thalos will start streaming blocks starting from this one. if undefined, the currect block reported by `api` is used. Thalos will start streaming blocks starting from this one. if undefined, the currect block reported by `api` is used.
`ship.end_block_num` (`integer`) `ship.end_block_num` ([`integer`](#integer))
Thalos will stop streaming when the block number defined by this value will be reached. if undefined thalos will never stop. Thalos will stop streaming when the block number defined by this value will be reached. if undefined thalos will never stop.
### Redis ### Redis
`redis.addr` (`string`) - Address (and port) to redis server `redis.addr` ([`string`](#string)) - Address (and port) to redis server
`redis.user` (`string`) - Username to use when authenticating `redis.user` ([`string`](#string)) - Username to use when authenticating
`redis.password` (`string`) - Password to use when authenticating `redis.password` ([`string`](#string)) - Password to use when authenticating
`redis.db` (`integer`) - Database index to use `redis.db` ([`integer`](#integer)) - Database index to use
`redis.prefix` (`string`) - Key prefix, this will be prepended to all channels that thalos is using to avoid name collision `redis.prefix` ([`string`](#string)) - Key prefix, this will be prepended to all channels that thalos is using to avoid name collision
### Logging ### Logging
This block configures how thalos will log information. This block configures how thalos will log information.
`log.filename` (`string`) - Filename (without extension) `log.filename` ([`string`](#string)) - Filename (without extension)
`log.directory` (`string`) - Directory where to store log files. `log.directory` ([`string`](#string)) - Directory where to store log files.
`log.timeformat` (`dateformat`) - Format to rename log files when rotating `log.timeformat` ([`dateformat`](#dateformat)) - Format to rename log files when rotating
`log.max_filesize` (`integer`) - Rotate when the file reaches this size. `log.max_filesize` ([`integer`](#integer)) - Rotate when the file reaches this size.
`log.max_time` (`duration_string`) - Rotate when the file is this old. `log.max_time` ([`duration_string`](#duration-string)) - Rotate when the file is this old.
### Telegram notifications ### Telegram notifications
@ -75,26 +75,26 @@ These settings control the telegram notification mechanism built into thalos.
if undefined thalos will simple skip this. if undefined thalos will simple skip this.
If they are defined, thalos will send messages when important events happen. If they are defined, thalos will send messages when important events happen.
`telegram.id` (`string`) - bot id `telegram.id` ([`string`](#string)) - bot id
`telegram.channel` (`integer`) - channel id to use. `telegram.channel` ([`integer`](#integer)) - channel id to use.
## Datatypes ## Datatypes
`string` ### string
A sequence of characters. A sequence of characters.
`integer` ### integer`
A valid integer. A valid integer.
`boolean` ### boolean
Boolean value (`true` or `false`) Boolean value (`true` or `false`)
`dateformat` ### dateformat
The dateformat type is a `string` but describes a date format in go. The dateformat type is a `string` but describes a date format in go.
@ -130,8 +130,9 @@ Go uses a different approach then other languages. usually you can format a date
| `MST` | Named timezone | CEST, GMT | | `MST` | Named timezone | CEST, GMT |
`duration_string` ### duration_string
A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`.
Valid time units are `"ns"`, `"us"` (or `"µs"`), `"ms"`, `"s"`, `"m"`, `"h"`. Valid time units are `"ns"`, `"us"` (or `"µs"`), `"ms"`, `"s"`, `"m"`, `"h"`.