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 #1909 from LiskHQ/1907-update-service-source-guide…
Browse files Browse the repository at this point in the history
…-with-pre-requisite-note

Update service source guide with pre-requisite note in Lisk Service v0.7.0
  • Loading branch information
sameersubudhi authored Nov 7, 2023
2 parents 2a4ad06 + 42bfe0e commit c120db0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
5 changes: 0 additions & 5 deletions docs/antora/modules/ROOT/pages/setup/docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@ It is recommended to set up a blockchain node first, before setting up Lisk Serv

== Setting up Lisk Service

[IMPORTANT]
====
It is strongly recommended to synchronize your blockchain node with the network **before** starting the Lisk Service.
====

=== Prerequisites

==== Requirements
Expand Down
22 changes: 15 additions & 7 deletions docs/antora/modules/ROOT/pages/setup/source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,26 @@ Mona Bärenfänger <[email protected]>
:url_config: configuration/source.adoc
:url_management_pm2: management/source.adoc
:url_references_config: configuration/index.adoc

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.
:url_core_setup_npm: v4@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.

This setup requires more steps than the Docker image installation, however this provides the developer with the possibility to customize the Lisk Service codebase.

[NOTE]
====
*Pre-requisite*
Lisk Service is a web application middleware that allows interaction with various blockchain networks based on the Lisk protocol.
It is recommended to set up a blockchain node first, before setting up Lisk Service.
* To set up a Lisk-Core node, see any of our setup guides, such as xref:{url_core_setup_npm}[].
* Alternatively, you can set up a sidechain node to connect to Lisk Service.
* Please make sure to set `system.keepEventsForHeights: -1` in the node config before synchronizing the node with the network.
====

== Prerequisites

The following dependencies are required to install and run Lisk Service from Source.
Expand Down Expand Up @@ -320,11 +333,6 @@ npm install -g pm2

== Installation

[IMPORTANT]
====
It is strongly recommended that you synchronize your Lisk Core node with the network **before** starting the Lisk Service.
====

If you have not already done so, clone the {url_github_service}[lisk-service^] GitHub repository and then navigate into the project folder and check out the latest release.

.Clone Lisk Service repository
Expand Down

0 comments on commit c120db0

Please sign in to comment.