clarify the sample configuration

test/config.yaml

@@ -1,72 +1,76 @@
-# Test configuration for lcpserver, lsdserver and frontend.
+# Test configuration for lcpserver and lsdserver.
 # It is meant to be used as a quick-start setup.
 #
-# Replace every occurence of <LCP_HOME> by the absolute path to the folder
-# hosting encrypted files, databases and certificates.
-
+# Replace every occurence of <LCP_SERVER>:<PORT> by the License Server host name or IP address + port.
+# Replace every occurence of <LSD_SERVER> by the Status Server host name.
+# Replace every occurence of <GATEWAY> by the License Gateway host name.
+# Replace every occurence of <LCP_HOME> by the absolute path to the folder hosting every file associated with the LCP service.
 
 # Shared configuration
 
 # The usernames and passwords must match the ones in the htpasswd files for each server.
 
 lcp:
-    public_base_url:  "http://127.0.0.1:8989"
+    # the public url a client app will use to access the License Server (optional)
+    public_base_url:  "http://<LCP_SERVER>:<PORT>"
 lcp_update_auth: 
-    username: "adm_username"
-    password: "adm_password"
+    # login and password used by the Status Server to access the License Server
+    username: "<adm_username>"
+    password: "<adm_password>"
 
 lsd:
-    public_base_url:  "http://127.0.0.1:8990"
+    # the public url a client app will use to access the Status Server
+    public_base_url:  "https://<PUBLIC_LSD_SERVER>"
 lsd_notify_auth: 
-    username: "adm_username"
-    password: "adm_password"
+    # login and password used by the License Server to access the Status Server
+    username: "<adm_username>"
+    password: "<adm_password>"
 
 
 # LCP Server
 
 profile: "basic"
 lcp:
-    host: "127.0.0.1"
-    port: 8989
+    # the port on which the License Server will be running
+    port: <PORT>
+    # replace this dsn if you're not using SQLite 
     database: "sqlite3://file:<LCP_HOME>/db/lcp.sqlite?cache=shared&mode=rwc"
-    auth_file: "<LCP_HOME>/htpasswd"
-storage:
-    filesystem:
-        directory: "<LCP_HOME>/files/storage"
+    # authentication file of the License Server. Here we use the same file for the License Server and Status Server
+    auth_file: "<LCP_HOME>/config/htpasswd"
+# uncomment if lcpencrypt does not manage the storage of encrypted publications
+#storage:
+#    filesystem:
+#        directory: "<LCP_HOME>/files/storage"
 certificate:
-    cert: "<LCP_HOME>/cert/cert-edrlab-test.pem"
-    private_key: "<LCP_HOME>/cert/privkey-edrlab-test.pem"
+    # theses test certificates are provided in the test/cert folder of the codebase
+    cert: "<LCP_HOME>/config/cert-edrlab-test.pem"
+    private_key: "<LCP_HOME>/config/privkey-edrlab-test.pem"
 license:
     links:
-        status: "http://127.0.0.1:8990/licenses/{license_id}/status"     
-        hint: "http://127.0.0.1:8991/static/hint.html"
-        publication: "http://127.0.0.1:8989/contents/{publication_id}" 
+        # leave the url as-is (after <LSD_SERVER> has been resolved)
+        status: "http://<LSD_SERVER>/licenses/{license_id}/status"     
+        # the url of a REAL html page, that indicates how the user can get back his passphrase if forgotten
+        hint: "<CUSTOM_HINT_PAGE_URL>"
 
 
 # LSD Server
 
 lsd:
-    host: "127.0.0.1"
-    port: 8990
+    # the port on which the Status Server will be running
+    port: <PORT>
+    # replace this dsn if you're not using SQLite 
     database: "sqlite3://<LCP_HOME>/db/lsd.sqlite?cache=shared&mode=rwc"
-    auth_file: "<LCP_HOME>/htpasswd"
-    license_link_url: "http://127.0.0.1:8991/api/v1/licenses/{license_id}"
+    # authentication file of the Status Server. Here we use the same file for the License Server and Status Server
+    auth_file: "<LCP_HOME>/config/htpasswd"
+    # in this example, the License Gateway is developed so that adding a license id 
+    # to the host name gives access to a fresh license.   
+    # Keep {license_id} as-is; this is a template. 
+    # Read the doc to know more about how to develop a License Gateway.
+    license_link_url: "http://<GATEWAY>/{license_id}"
 license_status:
     register: true
-    renew: true
-    return: true
-    renting_days: 60
-    renew_days: 7
-
-
-# Frontend Server
-
-frontend:
-    host: "127.0.0.1"
-    port: 8991
-    database: "sqlite3://file:<LCP_HOME>/db/frontend.sqlite?cache=shared&mode=rwc"
-    master_repository: "<LCP_HOME>/files/master"
-    encrypted_repository: "<LCP_HOME>/files/encrypted"
-    provider_uri: "https://www.myprovidername.org"
-    right_print: 10
-    right_copy: 2000
+    # uncomment the lines below if you're allowing e-lending
+    #renew: true
+    #return: true
+    #renting_days: 60
+    #renew_days: 7