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 #1991 from LiskHQ/1990-update-Redis-setup-instruct…
Browse files Browse the repository at this point in the history
…ions

Update Redis set up instructions in Lisk service docs
  • Loading branch information
sameersubudhi authored Jan 2, 2024
2 parents 53461f8 + ace7b50 commit 18b499a
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/antora/modules/ROOT/pages/setup/source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Mona Bärenfänger <mona@lightcurve.io>
: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/
Expand All @@ -29,6 +32,7 @@ Mona Bärenfänger <mona@lightcurve.io>
: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.
Expand Down Expand Up @@ -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.
Expand All @@ -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^].
--
====

Expand Down

0 comments on commit 18b499a

Please sign in to comment.