Skip to content

Commit 6aeea51

Browse files
committed
More documentation
1 parent c3788c9 commit 6aeea51

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

server/nodejs/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,12 @@ or QT debug console)
4646
## Configuring for Production Use
4747
Before deploying syscoin-api for production use you will need to modify the following files:
4848

49-
1. `host` value in `/api/swagger.yaml`
50-
1. `swaggerSpec.host` value located in `../../swagger-ui/dist/swagger-spec.js`
49+
1. `host` value in [`/api/swagger.yaml`](api/swagger.yaml)
50+
1. `swaggerSpec.host` value located in [`../../swagger-ui/dist/swagger-spec.js`](../../swagger-ui/dist/swagger-spec.js)
51+
1. `HOST` value in [`/spec/config.js`](spec/config.js)
5152

52-
In both these files modify the `host` value from `localhost:8001` to `SERVERIP:8001`. Replacing SERVERIP with your server's
53-
production IP or domain. You can also optionally change the port. It is highly recommended that you allow only HTTPS
54-
access in production and secure connections with a valid SSL certificate.
53+
In all these files modify the specified value from `localhost:8001` to `SERVERIP:8001`. Replacing `SERVERIP` with your server's
54+
production IP or domain. You can also optionally change the port.
55+
56+
**It is highly recommended that you allow only HTTPS
57+
access in production deployments and secure all connections with a valid SSL certificate. Failure to do this can expose the wallet to attack.**

server/nodejs/spec/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
HOST: "http://localhost:8001/", //include trailing slash
3-
DEBUG_ENABLED: true,
3+
DEBUG_ENABLED: false,
44

55
TEST_ALIAS_PEG: "sysrates.peg",
66
TEST_ALIAS: "testuser",

0 commit comments

Comments
 (0)