Update the doc for Silverpeas

silverpeas/content.md

@@ -18,7 +18,7 @@ Docker images of Silverpeas require one of the following database system in orde
 
 The Silverpeas images support actually only the two first database systems; because of the non-free licensing issues with the Oracle JDBC drivers, Silverpeas cannot include these drivers by default and consequently it cannot use transparently an Oracle database system as a persistence backend.
 
-For the same reasons, the Docker images of Silverpeas aren't shipped with the Oracle JVM but with the default OpenJDK. Silverpeas uses the Wildfly application server as runtime.
+For the same reasons, the Docker images of Silverpeas aren't shipped with the Oracle JVM but with OpenJDK. Silverpeas uses the Wildfly application server as runtime.
 
 The Silverpeas images use the following environment variables to set the database access parameters:
 
@@ -41,7 +41,7 @@ $ docker run --name postgresql -d \
     postgres:9.6
 ```
 
-We recommend strongly to mount the directory with the database file on the host so the data won't be lost when upgrading PostgreSQL to a newer version (a Data Volume Container can be used instead). For any information how to start a PostgreSQL container, you can refer its [documentation]((https://hub.docker.com/_/postgres/).
+We recommend strongly to mount the directory with the database file on the host so the data won't be lost when upgrading PostgreSQL to a newer version (a Data Volume Container can be used instead). For any information how to start a PostgreSQL container, you can refer its [documentation](https://hub.docker.com/_/postgres/).
 
 Once the database system is running, a database for Silverpeas has to be created and a user with administrative rights on this database (and only on this database) should be added; it is recommended for a security reason to create a dedicated user account in the database for each application and therefore for Silverpeas. In this document, and by default, a database `Silverpeas` and a user `silverpeas` for that database are created.
 
@@ -60,13 +60,15 @@ $ docker run --name silverpeas -p 8080:8000 -d \
     silverpeas
 ```
 
-Here, as the PostgreSQL database is linked under the alias `database`, we don't have to explicitly indicate its hostname with the `DB_SERVER` environment variable. The Silverpeas images expose the 8000 port and here this port is mapped to the 8080 port of the host; Silverpeas is then accessible at `http://localhost:8080/silverpeas`. You can sign in Silverpeas with the administrator account `SilverAdmin` and with as password `SilverAdmin`.
+By default, `database` is the default hostname used by Silverpeas for its persistence backend. So, as the PostgreSQL database is linked here under the alias `database`, we don't have to explicitly indicate its hostname with the `DB_SERVER` environment variable. The Silverpeas images expose the 8000 port and here this port is mapped to the 8080 port of the host; Silverpeas is then accessible at `http://localhost:8080/silverpeas`. You can sign in Silverpeas with the administrator account `SilverAdmin` and with as password `SilverAdmin`.
 
-By default, some volumes are created inside the container, so that we can access them in the host.(Refers the [Docker Documentation](https://docs.docker.com/engine/tutorials/dockervolumes/#locating-a-volume) to locate them.) Among them `/opt/silverpeas/log` and `/opt/silverpeas/data`: the first volume contains the logs produced by Silverpeas whereas the second volume contains all the data that are created and managed by the users in Silverpeas. Because the latter has already a directories structure created at image creation, a host directory cannot be mounted into the container at `opt/silverpeas/data` without losing the volume's content (the mount point overlays the pre-existing content of the volume). In our example, in order to easily locate the two volumes, we label them explicitly with respectively the labels `silverpeas-log` and `silverpeas-data`. (Using a [Data Volume Container](https://docs.docker.com/engine/userguide/containers/dockervolumes/) to map `/opt/silverpeas/log` and `/opt/silverpeas/data` is a better solution.)
+By default, some volumes are created inside the container, so that we can access them in the host. (Refers the [Docker Documentation](https://docs.docker.com/engine/tutorials/dockervolumes/#locating-a-volume) to locate them.) Among them `/opt/silverpeas/log` and `/opt/silverpeas/data`: the first volume contains the logs produced by Silverpeas whereas the second volume contains all the data that are created and managed by the users in Silverpeas. Because the latter has already a directories structure created at image creation, a host directory cannot be mounted into the container at `opt/silverpeas/data` without losing the volume's content (the mount point overlays the pre-existing content of the volume). In our example, in order to easily locate the two volumes, we label them explicitly with respectively the labels `silverpeas-log` and `silverpeas-data`. (Using a [Data Volume Container](https://docs.docker.com/engine/userguide/containers/dockervolumes/) to map `/opt/silverpeas/log` and `/opt/silverpeas/data` is a better solution.)
+
+Silverpeas takes some time to start, so we recommend you to glance at the logs the complete starting of Silverpeas (see the section about the logs).
 
 ### Start a Silverpeas instance with a finer configuration
 
-The Silverpeas global configuration is defined in the `/opt/silverpeas/configuration/config.properties` file whose a sample can be found [here](https://raw.githubusercontent.com/Silverpeas/Silverpeas-Distribution/master/src/main/dist/configuration/sample_config.properties) or in the container directory `/opt/silverpeas/configuration/`. You can explicitly create the `config.properties` file with, additionally to the database access parameters, your peculiar configuration parameters and then start a Silverpeas instance with this configuration file:
+The Silverpeas global configuration is defined in the `/opt/silverpeas/configuration/config.properties` file whose a sample can be found [here](https://raw.githubusercontent.com/Silverpeas/Silverpeas-Distribution/master/src/main/dist/configuration/sample_config.properties) or in the container directory `/opt/silverpeas/configuration/`. You can explicitly create the `config.properties` file with, additionally to the database access parameters (don't forget in that case to specify the `DB_SERVER` property with as value `database`), your peculiar configuration parameters and then start a Silverpeas instance with this configuration file:
 
 ```console
 $ docker run --name silverpeas -p 8080:8000 -d \
@@ -79,6 +81,29 @@ $ docker run --name silverpeas -p 8080:8000 -d \
 
 where `/etc/silverpeas/config.properties` is your own configuration file on the host. For security reason, we strongly recommend to set explicitly the administrator's credentials with the properties `SILVERPEAS_ADMIN_LOGIN` and `SILVERPEAS_ADMIN_PASSWORD` in the `config.properties` file. (Don't forget to set also the administrator email address with the property `SILVERPEAS_ADMIN_EMAIL`.)
 
+Below an example of such a configuration file:
+
+	SILVERPEAS_ADMIN_LOGIN=SilverAdmin
+	SILVERPEAS_ADMIN_PASSWORD=theadministratorpassword
+	[email protected]
+	
+	DB_SERVERTYPE=POSTGRESQL
+	DB_SERVER=database
+	DB_NAME=Silverpeas
+	DB_USER=silverpeas
+	DB_PASSWORD=thesilverpeaspassword
+	
+	CONVERTER_HOST=libreoffice
+	CONVERTER_PORT=8997
+	
+	SMTP_SERVER=smtp.foo.com
+	SMTP_AUTHENTICATION=true
+	SMTP_DEBUG=false
+	SMTP_PORT=465
+	SMTP_USER=silverpeas
+	SMTP_PASSWORD=thesmtpsilverpeaspassword
+	SMTP_SECURE=true
+
 ## Start a Silverpeas instance with a database on the host
 
 For a database system running on the host (or on a remote host) with 192.168.1.14 as IP address, you have to specify this host both to the container at starting and to Silverpeas by defining it into its global configuration file:
@@ -120,7 +145,7 @@ Beside these directories, according to your specific needs, custom configuration
 
 The directories `/opt/silverpeas/log`, `/opt/silverpeas/data`, and `/opt/silverpeas/xmlcomponents/workflows` are all defined as volumes in the Docker image.
 
-All these different kind of data have to be consistent for a given state of Silverpeas; they form a coherent whole. Then, defining a Data Volume Container to gather all of these volumes is a better solution over multiple shared-storage volume definitions. You can, with a such Data Volume Container, backup, restore or migrate more easily the full set of the data of Silverpeas.
+All these different kind of data have to be consistent for a given state of Silverpeas; they form a coherent whole set. Then, defining a Data Volume Container to gather all of these volumes is a better solution over multiple shared-storage volume definitions. You can, with a such Data Volume Container, backup, restore or migrate more easily the full set of the data of Silverpeas.
 
 To define a Data Volume Container for Silverpeas, for example:
 
@@ -129,7 +154,7 @@ $ docker create --name silverpeas-store \
     -v silverpeas-data:/opt/silverpeas/data \
     -v silverpeas-log:/opt/silverpeas/log \
     -v silverpeas-workflows:/opt/silverpeas/xmlcomponents/workflows \
-    -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/properties \
+    -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties \
     silverpeas \
     /bin/true
 ```
@@ -150,7 +175,7 @@ $ docker create --name silverpeas-store \
     -v silverpeas-data:/opt/silverpeas/data \
     -v silverpeas-log:/opt/silverpeas/log \
     -v silverpeas-properties:/opt/silverpeas/properties \
-    -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/properties \
+    -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties \
     -v /etc/silverpeas/CustomerSettings.xml:/opt/silverpeas/configuration/silverpeas/CustomerSettings.xml \
     -v /etc/silverpeas/my-datasource.cli:/opt/silverpeas/configuration/jboss/my-datasource.cli \
     silverpeas \
@@ -198,3 +223,5 @@ The output of Wildfly is redirected into the container standard output and so it
 ```console
 $ docker logs -f silverpeas
 ```
+
+Silverpeas takes some time to start, so we recommend you to glance at the logs for the complete starting of Silverpeas.