Loop documentation updated

Loop documentation updated
pull/294/head^2
Shahana Farooqui 4 years ago
parent 86d7d1ffa8
commit cf71a4d897

@ -107,7 +107,8 @@ Example RTL-Config.json:
"bitcoindConfigPath": "<Optional: path of bitcoind.conf path if available locally>",
"enableLogging": true,
"fiatConversion": false,
"lnServerUrl": "<url for LND REST APIs for node #1 e.g. https://192.168.0.1:8080/v1>"
"lnServerUrl": "<url for LND REST APIs for node #1 e.g. https://192.168.0.1:8080/v1>",
"swapServerUrl": "<url for swap server REST APIs for the node. e.g. http://localhost:8081/v1>"
}
}
]

@ -64,7 +64,7 @@ connect.setDefaultConfig = () => {
channelBackupPath: channelBackupPath,
enableLogging: false,
lnServerUrl: "https://localhost:8080/v1",
swapServerUrl: "https://localhost:8081/v1",
swapServerUrl: "http://localhost:8081/v1",
fiatConversion: false
}
}

@ -30,7 +30,8 @@ parameters have `default` values for initial setup and can be updated after RTL
"enableLogging": <Parameter to turn RTL logging off/on. Allowed values - true, false, default false, Required>,
"fiatConversion": <parameter to turn fiat conversion off/on. Allowed values - true, false, default false, Required>,
"currencyUnit": "<Optional: Fiat current Unit for currency conversion, default 'USD' If fiatConversion is true, Required if fiatConversion is true>",
"lnServerUrl": "<Service url for LND/CLightning REST APIs for the node, e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. Default 'https://localhost:8080/v1', Required"
"lnServerUrl": "<Service url for LND/CLightning REST APIs for the node, e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. Default 'https://localhost:8080/v1', Required",
"swapServerUrl": "<Service url for swap server REST APIs for the node, e.g. http://localhost:8081/v1, Optional>",
}
}
]

@ -24,7 +24,8 @@ This step is only required to configure the nodes, which will be remotely connec
6. `nodes` section is a json array, with each element of the array representing the specific parameters for the LND node to connect with. `index` must be a number and start with 1. This number must be unique for each node in the array. For each element, two items need to be configured for each node on the network (`macaroonPath` and `lnServerUrl`).
7. `macaroonPath` should be set to the local path of the folder containing `admin.macaroon` file for each node. Each node must have a different folder for the `admin.macaroon` on the RTL server.
8. `lnServerUrl` must be set to the service url for LND/C Lightining REST APIs for each node, with the unique ip address of the node hosting lnd/clightning e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. In this case the ip address of the node hosting lnd/clightning is '192.168.0.1'
9. `configPath` and `bitcoindConfigPath` are optional parameters which can be set only if the RTL is running locally on the same node. Else it can be set to "" or removed from the conf file all together.
9. `swapServerUrl` must be set to the swap service url. e.g. http://localhost:8081/v1.
10. `configPath` and `bitcoindConfigPath` are optional parameters which can be set only if the RTL is running locally on the same node. Else it can be set to "" or removed from the conf file all together.
#### 3. Restart RTL

@ -37,7 +37,8 @@ If your running RTL and LND on different devices on your local LAN, certain conf
"bitcoindConfigPath": "<Optional: path of bitcoind.conf path if available locally>",
"enableLogging": false,
"fiatConversion": false,
"lnServerUrl": "<https://<ip-address-of-device-running-lnd>:8080/v1; e.g. https://192.168.0.1:8080/v1>"
"lnServerUrl": "<https://<ip-address-of-device-running-lnd>:8080/v1; e.g. https://192.168.0.1:8080/v1>",
"swapServerUrl": "<http://<localhost>:8081/v1>",
}
}
]

@ -23,6 +23,7 @@
"channelBackupPath": "C:\\Users\\shaha\\backup\\node-1",
"enableLogging": false,
"lnServerUrl": "https://localhost:8080/v1",
"swapServerUrl": "http://localhost:8081/v1",
"fiatConversion": false
}
}

Loading…
Cancel
Save