Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1764 from LiskHQ/1724-align-code-snippets
Browse files Browse the repository at this point in the history
Align code snippets
  • Loading branch information
sameersubudhi authored Aug 3, 2023
2 parents 1b3d73a + 31d7ab0 commit 122e722
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 140 deletions.
56 changes: 28 additions & 28 deletions docs/antora/modules/ROOT/pages/configuration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Muhammad Talha <muhammad.talha@lightcurve.io>
:url_pm2: https://pm2.keymetrics.io/
:url_config_file: https://github.com/LiskHQ/lisk-service/blob/development/ecosystem.config.js
:url_lisk_service_repo: https://github.com/LiskHQ/lisk-service

:source-language: js

On the xref:{url_intro_services}[Introduction to Lisk Service] page, we have discussed the various xref:{url_microservices}[microservices] that combine to form Lisk Service.
On this page, we will thoroughly discuss the configuration options available for each service.
Expand Down Expand Up @@ -49,12 +49,12 @@ This could be a NATS or a Redis instance.
| number
| Inter-microservice request timeout in seconds.
| 10
| `SERVICE_LOG_LEVEL`
| string
| Set the application logging level; Available options are `trace`, `debug`, `info`, `warn`, `error`, and `fatal`.
| info
| `SERVICE_LOG_STDOUT`
| string
| Enable posting logs to the standard output stream.
Expand Down Expand Up @@ -83,7 +83,7 @@ For example, Graylog 'localhost:12201/udp'.
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -138,7 +138,7 @@ Properties::
| string
| URL of the host.
| 127.0.0.1
| `SERVICE_BROKER`
| string
| URL of the microservice message broker (NATS or Redis).
Expand All @@ -148,7 +148,7 @@ Properties::
| string
| Ensures that JSON-RPC accepts a valid JSON-RPC 2.0 envelope.
| false
| `ENABLE_HTTP_API`
| string
| Enables particular HTTP API endpoints.
Expand Down Expand Up @@ -229,7 +229,7 @@ This would include the Cache-Control header within the responses.
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -284,7 +284,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `LISK_APP_WS`
| string
| URL to connect with the Lisk application node over WebSocket.
Expand All @@ -294,7 +294,7 @@ Properties::
| string
| Boolean flag to enable IPC-based connection to the Lisk application node.
Requires `LISK_APP_DATA_PATH` to be set.
| true
| true
| `LISK_APP_DATA_PATH`
| string
Expand All @@ -318,7 +318,7 @@ Only to be used when the genesis block is large enough to be transmitted over AP
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -363,7 +363,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_MESSAGE_QUEUE_REDIS`
| string
| URL of the Redis instance hosting the job queue to schedule the block indexing jobs.
Expand All @@ -376,7 +376,7 @@ Must match the value supplied for the `indexer` microservice.
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -416,7 +416,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_INDEXER_MYSQL`
| string
| Connection string of the MySQL instance that the microservice connects to.
Expand Down Expand Up @@ -458,7 +458,7 @@ Must match the value supplied for the `coordinator` microservice.
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -504,7 +504,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_APP_REGISTRY_MYSQL`
| string
| Connection string of the MySQL instance that the microservice connects to.
Expand All @@ -521,7 +521,7 @@ Properties::
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -562,7 +562,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_FEE_ESTIMATOR_CACHE`
| string
| URL of the cache storage (Redis).
Expand Down Expand Up @@ -594,7 +594,7 @@ Properties::
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -639,7 +639,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_STATISTICS_MYSQL`
| string
| Connection string of the MySQL instance that the microservice connects to.
Expand All @@ -661,7 +661,7 @@ Properties::
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -702,17 +702,17 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_MARKET_REDIS`
| string
| URL of the cache storage (Redis).
| redis://localhost:6379/2
| `SERVICE_MARKET_FIAT_CURRENCIES`
| string
| Fiat currencies are used for price calculation.
| Fiat currencies are used for price calculation.
All Fiat currencies used here need to be comma separated.
| EUR,USD,CHF,GBP,RUB
| EUR,USD,CHF,GBP,RUB
| `SERVICE_MARKET_TARGET_PAIRS`
| string
Expand All @@ -725,14 +725,14 @@ The values listed here must be comma separated.
| Optional API key for https://exchangeratesapi.io/.
The `/market/prices` endpoint will respond with additional data, specifically the exchange rates for various cryptocurrencies in other fiat currencies.
The free plan would suffice for Lisk Service.
|
|
|===
--
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -774,7 +774,7 @@ Properties::
| string
| URL of the microservice message broker (NATS or Redis).
| redis://localhost:6379/0
| `SERVICE_EXPORT_REDIS`
| string
| URL of the permanent cache storage (Redis).
Expand All @@ -791,7 +791,7 @@ Properties::
Sample::
+
--
[source,js]
----
module.exports = {
apps: [
Expand Down Expand Up @@ -832,7 +832,7 @@ module.exports = {
// | string
// | Enable or disable apply snapshot feature.
// | true

// | `INDEX_SNAPSHOT_URL`
// | string
// | Custom snapshot URL: expected to end with "sql.gz".
Expand Down
Loading

0 comments on commit 122e722

Please sign in to comment.