Merge branch 'main' of https://github.com/emotemot/planetmint into emotemot-main

This commit is contained in:
Jürgen Eckel
2022-01-26 15:46:03 +01:00
38 changed files with 186 additions and 125 deletions

View File

@@ -37,7 +37,7 @@ The settings with names of the form `database.*` are for the backend database
* `database.backend` can only be `localmongodb`, currently.
* `database.host` is the hostname (FQDN) of the backend database.
* `database.port` is self-explanatory.
* `database.name` is a user-chosen name for the database inside MongoDB, e.g. `bigchain`.
* `database.name` is a user-chosen name for the database inside MongoDB, e.g. `planetmint`.
* `database.connection_timeout` is the maximum number of milliseconds that Planetmint will wait before giving up on one attempt to connect to the backend database.
* `database.max_tries` is the maximum number of times that Planetmint will try to establish a connection with the backend database. If 0, then it will try forever.
* `database.replicaset` is the name of the MongoDB replica set. The default value is `null` because in Planetmint 2.0+, each Planetmint node has its own independent MongoDB database and no replica set is necessary. Replica set must already exist if this option is configured, Planetmint will not create it.
@@ -51,7 +51,7 @@ If you use all the default Planetmint configuration settings, then no authentica
**Username/Password Authentication**
To use username/password authentication, a MongoDB instance must already be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `bigchain`, which is the default `database.name`), and that database must already have a "readWrite" user with associated username and password. To create such a user, login to your MongoDB instance as Admin and run the following commands:
To use username/password authentication, a MongoDB instance must already be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `planetmint`, which is the default `database.name`), and that database must already have a "readWrite" user with associated username and password. To create such a user, login to your MongoDB instance as Admin and run the following commands:
```text
use <database.name>
@@ -64,7 +64,7 @@ db.createUser({user: "<database.login>", pwd: "<database.password>", roles: [{ro
**x.509 Certificate Authentication**
To use x.509 certificate authentication, a MongoDB instance must be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `bigchain`, which is the default `database.name`), and that database must be set up to use x.509 authentication. See the MongoDB docs about how to do that.
To use x.509 certificate authentication, a MongoDB instance must be running somewhere (maybe in another machine), it must already have a database for use by Planetmint (usually named `planetmint`, which is the default `database.name`), and that database must be set up to use x.509 authentication. See the MongoDB docs about how to do that.
* `database.login` is the user's username.
* `database.password` isn't used so the default value (`null`) is fine.
@@ -91,7 +91,7 @@ If (no environment variables were set and there's no local config file), or you
"backend": "localmongodb",
"host": "localhost",
"port": 27017,
"name": "bigchain",
"name": "planetmint",
"connection_timeout": 5000,
"max_tries": 3,
"replicaset": null,
@@ -213,7 +213,7 @@ different from where Planetmint is running.
```text
export PLANETMINT_WSSERVER_ADVERTISED_SCHEME=wss
export PLANETMINT_WSSERVER_ADVERTISED_HOST=myplanetmint.com
export PLANETMINT_WSSERVER_ADVERTISED_HOST=myplanetmint.io
export PLANETMINT_WSSERVER_ADVERTISED_PORT=443
```
@@ -222,7 +222,7 @@ export PLANETMINT_WSSERVER_ADVERTISED_PORT=443
```js
"wsserver": {
"advertised_scheme": "wss",
"advertised_host": "myplanetmint.com",
"advertised_host": "myplanetmint.io",
"advertised_port": 443
}
```
@@ -283,14 +283,14 @@ specified path.
**Log rotation:** Log files have a size limit of about 200 MB
and will be rotated up to five times.
For example, if `log.file` is set to `"~/planet.log"`, then
logs would always be written to `planet.log`. Each time the file
`planet.log` reaches 200 MB it will be closed and renamed
`planet.log.1`. If `planet.log.1` and `planet.log.2` already exist they
would be renamed `planet.log.2` and `planet.log.3`. This pattern would be
applied up to `planet.log.5` after which `planet.log.5` would be
overwritten by `planet.log.4`, thus ending the rotation cycle of whatever
logs were in `planet.log.5`.
For example, if `log.file` is set to `"~/planetmint.log"`, then
logs would always be written to `planetmint.log`. Each time the file
`planetmint.log` reaches 200 MB it will be closed and renamed
`planetmint.log.1`. If `planetmint.log.1` and `planetmint.log.2` already exist they
would be renamed `planetmint.log.2` and `planetmint.log.3`. This pattern would be
applied up to `planetmint.log.5` after which `planetmint.log.5` would be
overwritten by `planetmint.log.4`, thus ending the rotation cycle of whatever
logs were in `planetmint.log.5`.
### log.error_file
@@ -386,7 +386,7 @@ where it can connect to the node's Tendermint instance.
```text
export PLANETMINT_TENDERMINT_HOST=tendermint
export PLANETMINT_TENDERMINT_PORT=26657
```
```Planetmint
**Default values**