From 9996d3af5a85e68baebfac7f7b3fc1a8cf7ea409 Mon Sep 17 00:00:00 2001 From: chris529 Date: Thu, 14 Dec 2023 13:27:22 +0100 Subject: [PATCH 1/6] update in source.adoc --- docs/antora/modules/ROOT/pages/setup/source.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index ceefa48550..fcbba52bea 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -29,6 +29,7 @@ Mona Bärenfänger :url_references_config: configuration/index.adoc :url_core_setup_npm: lisk-core::setup/npm.adoc + As an alternative to the Docker image setup, it is also possible to install Lisk Service from source code. TIP: Install from source code if you want to customize the codebase of Lisk Service, e.g. if you want to adjust the API to be fully compatible with your blockchain application. From 5a467869a2824ef5a3465a525d4974cbabf5f0e6 Mon Sep 17 00:00:00 2001 From: chris529 Date: Thu, 14 Dec 2023 13:41:42 +0100 Subject: [PATCH 2/6] update in source.adoc --- docs/antora/modules/ROOT/pages/setup/source.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index fcbba52bea..ff440d3363 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -4,6 +4,7 @@ Mona Bärenfänger :toc: :source-language: bash // URLs +:url_redis: https://redis.io/docs/install/install-redis/install-redis-on-linux/ :url_docker_install_linux: https://docs.docker.com/engine/install :url_docker_install_linux_compose: https://docs.docker.com/compose/install/ :url_docker_install_mac: https://docs.docker.com/docker-for-mac/install/ From 8f39238de0816510e8e18787be93bd6cc1150721 Mon Sep 17 00:00:00 2001 From: chris529 Date: Thu, 14 Dec 2023 14:48:21 +0100 Subject: [PATCH 3/6] update in source.adoc --- docs/antora/modules/ROOT/pages/setup/source.adoc | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index ff440d3363..2f2c574a9e 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -4,7 +4,8 @@ Mona Bärenfänger :toc: :source-language: bash // URLs -:url_redis: https://redis.io/docs/install/install-redis/install-redis-on-linux/ +:url_redis_install_ubuntu: https://redis.io/docs/install/install-redis/install-redis-on-linux/ +:url_redis_install_mac: https://redis.io/docs/install/install-redis/install-redis-on-mac-os/ :url_docker_install_linux: https://docs.docker.com/engine/install :url_docker_install_linux_compose: https://docs.docker.com/compose/install/ :url_docker_install_mac: https://docs.docker.com/docker-for-mac/install/ @@ -299,14 +300,12 @@ Redis system-wide:: + -- *Ubuntu* ----- -sudo apt-get install redis-server ----- + +To install Redis on Ubuntu, please follow the {url_redis_install_ubuntu}[official Redis installation guide]. *macOS* ----- -brew install redis ----- + +To install Redis on MacOS, please follow the {url_redis_install_mac}[official Redis installation guide]. -- ==== From fb14aa98c255eb57a509fcaf8d04d0767f35dcf7 Mon Sep 17 00:00:00 2001 From: chris529 Date: Thu, 14 Dec 2023 15:00:39 +0100 Subject: [PATCH 4/6] update in source.adoc --- docs/antora/modules/ROOT/pages/setup/source.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index 2f2c574a9e..aec8ac5f2d 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -4,6 +4,7 @@ Mona Bärenfänger :toc: :source-language: bash // URLs +:url_lisk_service_redis_auth: https://github.com/LiskHQ/lisk-service/blob/development/docs/redis_authentication.md :url_redis_install_ubuntu: https://redis.io/docs/install/install-redis/install-redis-on-linux/ :url_redis_install_mac: https://redis.io/docs/install/install-redis/install-redis-on-mac-os/ :url_docker_install_linux: https://docs.docker.com/engine/install @@ -286,6 +287,7 @@ docker run --name redis_service --port 6379:6379 -d redis:7-alpine ---- docker run --name redis_service -v /path/to/custom_redis.conf:/usr/local/etc/redis/redis.conf --port 6379:6379 -d redis:7-alpine ---- +NOTE: Starting with Lisk Service version 0.7.2 we strongly recommend using custom authentication in Redis. To learn more about it please check this {url_lisk_service_redis_auth}[guide] in the Lisk Service repository. The above commands should be enough to start Redis which is ready to use with Lisk Service. From 535f0a979981284dc42100069040f5a85dd4bac6 Mon Sep 17 00:00:00 2001 From: chris529 Date: Thu, 14 Dec 2023 15:05:15 +0100 Subject: [PATCH 5/6] update in source.adoc --- docs/antora/modules/ROOT/pages/setup/source.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index aec8ac5f2d..78f1451951 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -287,7 +287,7 @@ docker run --name redis_service --port 6379:6379 -d redis:7-alpine ---- docker run --name redis_service -v /path/to/custom_redis.conf:/usr/local/etc/redis/redis.conf --port 6379:6379 -d redis:7-alpine ---- -NOTE: Starting with Lisk Service version 0.7.2 we strongly recommend using custom authentication in Redis. To learn more about it please check this {url_lisk_service_redis_auth}[guide] in the Lisk Service repository. +NOTE: Starting with Lisk Service version 0.7.2 we strongly recommend using custom authentication in Redis. To learn more about it please check this {url_lisk_service_redis_auth}[guide^] in the Lisk Service repository. The above commands should be enough to start Redis which is ready to use with Lisk Service. @@ -303,11 +303,11 @@ Redis system-wide:: -- *Ubuntu* -To install Redis on Ubuntu, please follow the {url_redis_install_ubuntu}[official Redis installation guide]. +To install Redis on Ubuntu, please follow the {url_redis_install_ubuntu}[official Redis installation guide^]. *macOS* -To install Redis on MacOS, please follow the {url_redis_install_mac}[official Redis installation guide]. +To install Redis on MacOS, please follow the {url_redis_install_mac}[official Redis installation guide^]. -- ==== From ace7b5071560e8a31ced497e03c117e180fc8890 Mon Sep 17 00:00:00 2001 From: chris529 Date: Fri, 15 Dec 2023 14:14:42 +0100 Subject: [PATCH 6/6] Update docs/antora/modules/ROOT/pages/setup/source.adoc Co-authored-by: Muhammad Talha <13951043+TalhaMaliktz@users.noreply.github.com> --- docs/antora/modules/ROOT/pages/setup/source.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index 78f1451951..45607a12eb 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -287,7 +287,8 @@ docker run --name redis_service --port 6379:6379 -d redis:7-alpine ---- docker run --name redis_service -v /path/to/custom_redis.conf:/usr/local/etc/redis/redis.conf --port 6379:6379 -d redis:7-alpine ---- -NOTE: Starting with Lisk Service version 0.7.2 we strongly recommend using custom authentication in Redis. To learn more about it please check this {url_lisk_service_redis_auth}[guide^] in the Lisk Service repository. +NOTE: Starting with the Lisk Service version `0.7.2`, we strongly recommend using custom authentication in Redis. +To learn more about it, please check the {url_lisk_service_redis_auth}[Redis Authentication README^] in the Lisk Service repository. The above commands should be enough to start Redis which is ready to use with Lisk Service.