Skip to content

Commit

Permalink
readme updated on the use of the config file
Browse files Browse the repository at this point in the history
  • Loading branch information
llemeurfr committed Oct 18, 2016
1 parent 5a17f40 commit 1a8007c
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,18 @@ Server Configuration
====================

The server is controlled by a yaml configuration file (e.g. "config.yaml").
This file normally resides in the bin directory but the path to this configuration file can be changed using the environment variable READIUM_LICENSE_CONFIG.
The License Server and License Status Server will search their configuration file in the bin directory by default;
but the path to this file can be changed using the environment variable READIUM_LICENSE_CONFIG.
The License Server and License Status Server may share the same configuration file (if they are both executed on the same server)
or they can have their own configucation file. In the first case, the htpasswd file and database may also be shared.
In the latter case, the License Server will have a "lcp" section and a "lsd_notify_auth" section; the License Status Server will
have a "lsd" section.

"certificate": parameters related to the signature of the licenses
- "cert": the provider certificate file (.pem or .crt). It will be inserted in the licenses and used by clients for checking the signature.
- "private_key": the private key (.pem). It will be used for signing licenses.

"lcp" (License Server) & "lsd" (License Status Server) have an identical structure:
"lcp" (License Server) & "lsd" (License Status Server) sections have an identical structure:
- "host": the public server hostname, `hostname` by default
- "port": the listening port, `8989` by default
- "public_base_url": the public base URL, combination of the host and port values on http by default
Expand All @@ -124,7 +129,7 @@ of a license generation. The notification endpoint is configured in the "lsd" se
- "filesystem": parameters related to a file system storage
- "directory": absolute path to the directory in which the protected publications are stored.

"license": parameters related to static information to be included in all licenses
"license": parameters related to static information to be included in all licenses generated by the License Server
- "links": links that will be included in all licenses. "hint" and "publication" links are required in a Readium LCP license.
If no such link exists in the partial license passed from the frontend when a new license his requested,
these link values will be inserted in the partial license.
Expand Down

0 comments on commit 1a8007c

Please sign in to comment.