Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vfarcic authored Mar 2, 2017
1 parent e3621e7 commit d4c77ba
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,9 @@ The following query parameters can be used when `reqMode` is set to `http` or is
|srcPort |The source (entry) port of a service. Useful only when specifying multiple destinations of a single service. The parameter can be prefixed with an index thus allowing definition of multiple destinations for a single service (e.g. `srcPort.1`, `srcPort.2`, and so on).|No| |80|
|templateBePath|The path to the template representing a snippet of the backend configuration. If specified, the backend template will be loaded from the specified file. If specified, `templateFePath` must be set as well. See the [Templates](#templates) section for more info.| | |/tmpl/be.tmpl|
|templateFePath|The path to the template representing a snippet of the frontend configuration. If specified, the frontend template will be loaded from the specified file. If specified, `templateBePath` must be set as well. See the [Templates](#templates) section for more info.| | |/tmpl/fe.tmpl|
|users |A comma-separated list of credentials(<user>:<pass>) for HTTP basic auth, which applies only to the service that will be reconfigured. If used with usersSecret or when USERS environment variable is set password may be omitted - it will be taken from usersSecret file or global configuration if usersSecret is not present. |No| |usr1:pwd1,usr2:pwd2|
|usersSecret | Suffix of file name from which credentials will be taken for this service. Files must be a comma-separated list of credentials(<user>:<pass>). This suffix will be appended to '/run/secrets/dfp_users_' path, so when its value is `mysecrets` expected file to be found will be `/run/secrets/dfp_users_mysecrets`. |No| |monitoring|
|usersPassEncrypted| Indicates that passwords provided by users or usersSecret contain encrypted passwords. Passwords can be encrypted like this: `mkpasswd -m sha-512 password1` |No| false |true|


|users       |A comma-separated list of credentials (<user>:<pass>) for HTTP basic authentication. It applies only to the service that will be reconfigured. If used with `usersSecret`, or when `USERS` environment variable is set, password may be omitted. In that case, it will be taken from `usersSecret` file or the global configuration if `usersSecret` is not present. |No| |usr1:pwd1, usr2:pwd2|
|usersSecret |Suffix of Docker secret from which credentials will be taken for this service. Files must be a comma-separated list of credentials (<user>:<pass>). This suffix will be prepended with `dfp_users_`. For example, if the value is `mysecrets` the expected name of the Docker secret is `dfp_users_mysecrets`.|No| |monitoring|
|usersPassEncrypted|Indicates whether passwords provided by `users` or `usersSecret` contain encrypted data. Passwords can be encrypted with the command `mkpasswd -m sha-512 password1`|No|false|true|

The following query parameters can be used when `reqMode` is set to `tcp`.

Expand Down

0 comments on commit d4c77ba

Please sign in to comment.