Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Update service source guide with pre-requisite note in Lisk Service v0.7.0 #1909

Merged
merged 6 commits into from
Nov 7, 2023
Merged

Update service source guide with pre-requisite note in Lisk Service v0.7.0 #1909

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0c25b29
update in source.adoc
chris529 Nov 1, 2023
b1f3c96
update in source.adoc
chris529 Nov 1, 2023
b2b4595
update in source.adoc
chris529 Nov 1, 2023
70b6535
update in docker.adoc
chris529 Nov 1, 2023
c6a576f
update in source.adoc
chris529 Nov 2, 2023
42bfe0e
update in source.adoc
chris529 Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/antora/modules/ROOT/pages/setup/docker.adoc
View file
Open in desktop
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
18 changes: 13 additions & 5 deletions docs/antora/modules/ROOT/pages/setup/source.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,19 @@ Mona Bärenfänger <[email protected]>
:url_config: configuration/source.adoc
:url_management_pm2: management/source.adoc
:url_references_config: configuration/index.adoc
:url_core_setup_npm: v4@lisk-core::setup/npm.adoc

[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.
====
TalhaMaliktz marked this conversation as resolved.
Show resolved Hide resolved

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.
TalhaMaliktz marked this conversation as resolved.
Show resolved Hide resolved

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