diff --git a/docs/antora/modules/ROOT/pages/setup/source.adoc b/docs/antora/modules/ROOT/pages/setup/source.adoc index ceefa48550..45607a12eb 100644 --- a/docs/antora/modules/ROOT/pages/setup/source.adoc +++ b/docs/antora/modules/ROOT/pages/setup/source.adoc @@ -4,6 +4,9 @@ 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 :url_docker_install_linux_compose: https://docs.docker.com/compose/install/ :url_docker_install_mac: https://docs.docker.com/docker-for-mac/install/ @@ -29,6 +32,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. @@ -283,6 +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 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. @@ -297,14 +303,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^]. -- ====