Skip to content

Commit

Permalink
readme: more detailed information on test certificates, plus some notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
llemeurfr committed Jul 10, 2018
1 parent 16eb5a0 commit b6a28df
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Expand Up @@ -79,6 +79,8 @@ If you want to use the master branch:
```sh
// from the go workspace
cd $GOPATH
// get the different packages and their dependencies, install the packages
go get github.com/readium/readium-lcp-server
```

Alternatively, if you want to use a feature/F branch:
Expand Down Expand Up @@ -155,13 +157,17 @@ Here are details about the configuration properties:
- "database": the URI formatted connection string to the database, `sqlite3://file:lcp.sqlite?cache=shared&mode=rwc` by default
- "auth_file": mandatory; the authentication file (an .htpasswd). Passwords must be encrypted using MD5.

Note: It may be practical to put the authentication file in the configuration folder ("lcpconfig" in the samples below).

"storage" section: parameters related to the storage of encrypted publications.
- "filesystem" section: parameters related to a file system storage.
- "directory": absolute path to the directory in which the encrypted publications are stored.

"certificate" section: parameters related to the signature of 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.
- "cert": the provider certificate file (.pem or .crt). It will be inserted in the licenses and used by clients for checking the signature. A test certificate is provided in the test/cert directory of the project ("cert-edrlab-test.pem").
- "private_key": the private key (.pem). It will be used for signing licenses. A test private key is provided in the test/cert directory of the project ("privkey-edrlab-test.pem").

Note: It may be practical to put these files in the configuration folder ("lcpconfig" in the samples below).

"license" section: 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.
Expand Down Expand Up @@ -271,7 +277,7 @@ lcp_update_auth:
- "public_base_url": the public base URL, combination of the host and port values on http by default
- "database": the URI formatted connection string to the database, `sqlite3://file:frontend.sqlite?cache=shared&mode=rwc` by default
- "master_repository": repository where the uploaded EPUB files are stored before encryption.
- "encrypted_repository": repository where the encrypted EPUB files are stored after upload.
- "encrypted_repository": repository where the encrypted EPUB files are stored after upload. The LCP server must have access to the path declared here; it will move each encrypted file to its storage folder on notification of encryption from the Frontend Server.
- "directory": the directory containing the client app; by default $GOPATH/src/github.com/readium/readium-lcp-server/frontend/manage.
- "provider_uri": provider uri, which will be inserted in all licenses produced via this test frontend.
- "right_print": allowed number of printed pages, which will be inserted in all licenses produced via this test frontend.
Expand Down

0 comments on commit b6a28df

Please sign in to comment.