This repository has been archived by the owner on Jun 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1909 from LiskHQ/1907-update-service-source-guide…
…-with-pre-requisite-note Update service source guide with pre-requisite note in Lisk Service v0.7.0
- Loading branch information
Showing
2 changed files
with
15 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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 | ||
|