Skip to content
This repository has been archived by the owner on Sep 2, 2023. It is now read-only.

Commit

Permalink
update server-configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
reedrosenbluth committed Jul 22, 2015
1 parent cf95240 commit b4846fc
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion docs/server-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,47 @@ An example configuration file is provided [here](../config-example.json).

----------

### Version 2.0.3

### Changes

+ Add `proxy` property that provides ripple-lib with a proxy url to route websocket connections to rippled through

```js
{
'config_version': '2.0.2',
'debug': false,
'port': 5990,
'host': 'localhost',
'ssl_enabled': false,
'ssl': {
'key_path': './certs/server.key',
'cert_path': './certs/server.crt'
},
'db_path': './ripple-rest.db',
'max_transaction_fee': 1000000,
'proxy': 'http://username:password@0.0.0.0:3128'
'rippled_servers': [
'wss://s1.ripple.com:443'
],
'url_base': 'https://api.ripple.com:443'
}
```

+ `config_version` - will be checked by the configuration loader and it will throw an error if there have been breaking changes to the format
+ `port` - the port that the API server will be available on
+ `host` - the host the API server will be available on
+ `dp_path` - path for sqlite3 to save the database to. Can be populated with `:memory:` to run an in-memory version of the sqlite db
+ `ssl_enabled` - boolean to configure to server to host over SSL
+ `ssl` - if an object with `key_path` and `cert_path` are provided, the API server will be available over HTTPS
+ `max_transaction_fee` - the maximum fee you're willing to pay for a transaction, has to be a `Number`
+ `rippled_servers` - an array of server objects indicating which `rippled` servers the API should connect to. These should be configured to point to your local `rippled` if you are running one, instead of `s_west.ripple.com`
+ `proxy` - the url of a proxy server. Connections to the rippled_servers will be routed through here
+ `debug` - boolean to log debugging information
+ `url_base` - override the url base (protocol://host_name:port) that is used in url construction for rest responses

----------

### Version 2.0.2

### Changes
Expand Down Expand Up @@ -191,4 +232,4 @@ An example configuration file is provided [here](../config-example.json).
+ `ssl` - if an object with `key_path` and `cert_path` are provided, the API server will be available over HTTPS
+ `rippled_servers` - an array of server objects indicating which `rippled` servers the API should connect to. These should be configured to point to your local `rippled` if you are running one, instead of `s_west.ripple.com`

----------
----------

0 comments on commit b4846fc

Please sign in to comment.