|
@@ -79,10 +79,12 @@ These environment variables can be also defined as properties into the Silverpea
|
|
|
|
|
|
|
|
In [Docker Hub](https://hub.docker.com/), no Docker images of Microsoft SQLServer are currently available, but you will find a lot of images of PostgreSQL. For example, with an [official PostgreSQL docker image](https://hub.docker.com/_/postgres/), you can start a PostgreSQL instance initialized with a superuser `postgres` with as password `mysecretpassword`:
|
|
In [Docker Hub](https://hub.docker.com/), no Docker images of Microsoft SQLServer are currently available, but you will find a lot of images of PostgreSQL. For example, with an [official PostgreSQL docker image](https://hub.docker.com/_/postgres/), you can start a PostgreSQL instance initialized with a superuser `postgres` with as password `mysecretpassword`:
|
|
|
|
|
|
|
|
- $ docker run --name postgresql -d \
|
|
|
|
|
- -e POSTGRES_PASSWORD="mysecretpassword" \
|
|
|
|
|
- -v postgresql-data:/var/lib/postgresql/data \
|
|
|
|
|
- postgres:9.6
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name postgresql -d \
|
|
|
|
|
+ -e POSTGRES_PASSWORD="mysecretpassword" \
|
|
|
|
|
+ -v postgresql-data:/var/lib/postgresql/data \
|
|
|
|
|
+ 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/).
|
|
|
|
|
|
|
@@ -92,14 +94,16 @@ Once the database system is running, a database for Silverpeas has to be created
|
|
|
|
|
|
|
|
Finally, a Silverpeas instance can be started by specifying the required database access parameters with the environment variables. In the example, the database is named `Silverpeas` and the priviledged user is `silverpeas` with as password `thesilverpeaspassword`:
|
|
Finally, a Silverpeas instance can be started by specifying the required database access parameters with the environment variables. In the example, the database is named `Silverpeas` and the priviledged user is `silverpeas` with as password `thesilverpeaspassword`:
|
|
|
|
|
|
|
|
- $ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
- -e DB_NAME="Silverpeas" \
|
|
|
|
|
- -e DB_USER="silverpeas" \
|
|
|
|
|
- -e DB_PASSWORD="thesilverpeaspassword" \
|
|
|
|
|
- -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
- -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
- --link postgresql:database \
|
|
|
|
|
- silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
+ -e DB_NAME="Silverpeas" \
|
|
|
|
|
+ -e DB_USER="silverpeas" \
|
|
|
|
|
+ -e DB_PASSWORD="thesilverpeaspassword" \
|
|
|
|
|
+ -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
+ -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
+ --link postgresql:database \
|
|
|
|
|
+ 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`.
|
|
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`.
|
|
|
|
|
|
|
@@ -109,12 +113,14 @@ By default, some volumes are created inside the container, so that we can access
|
|
|
|
|
|
|
|
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, your peculiar configuration parameters and then start a Silverpeas instance with this configuration file:
|
|
|
|
|
|
|
|
- $ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
- -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties
|
|
|
|
|
- -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
- -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
- --link postgresql:database \
|
|
|
|
|
- silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
+ -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties
|
|
|
|
|
+ -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
+ -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
+ --link postgresql:database \
|
|
|
|
|
+ silverpeas
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
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`.)
|
|
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`.)
|
|
|
|
|
|
|
@@ -122,12 +128,14 @@ where `/etc/silverpeas/config.properties` is your own configuration file on the
|
|
|
|
|
|
|
|
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:
|
|
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:
|
|
|
|
|
|
|
|
- $ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
- --add-host=database:192.168.1.14 \
|
|
|
|
|
- -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties \
|
|
|
|
|
- -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
- -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
- silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
+ --add-host=database:192.168.1.14 \
|
|
|
|
|
+ -v /etc/silverpeas/config.properties:/opt/silverpeas/configuration/config.properties \
|
|
|
|
|
+ -v silverpeas-log:/opt/silverpeas/log \
|
|
|
|
|
+ -v silverpeas-data:/opt/silverpeas/data \
|
|
|
|
|
+ silverpeas
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
where `database` is the hostname referred by the `DB_SERVER` parameter in your `/etc/silverpeas/config.properties` file as the host running the database system and that is mapped here to the actual IP address of this host. The hostname is added in the `/etc/hosts` file in the container.
|
|
where `database` is the hostname referred by the `DB_SERVER` parameter in your `/etc/silverpeas/config.properties` file as the host running the database system and that is mapped here to the actual IP address of this host. The hostname is added in the `/etc/hosts` file in the container.
|
|
|
|
|
|
|
@@ -161,32 +169,38 @@ All these different kind of data have to be consistent for a given state of Silv
|
|
|
|
|
|
|
|
To define a Data Volume Container for Silverpeas, for example:
|
|
To define a Data Volume Container for Silverpeas, for example:
|
|
|
|
|
|
|
|
- $ 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 \
|
|
|
|
|
- silverpeas \
|
|
|
|
|
- /bin/true
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ 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 \
|
|
|
|
|
+ silverpeas \
|
|
|
|
|
+ /bin/true
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
Then to mount the volumes in the Silverpeas container:
|
|
Then to mount the volumes in the Silverpeas container:
|
|
|
|
|
|
|
|
- $ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
- --link postgresql:database \
|
|
|
|
|
- --volumes-from silverpeas-store \
|
|
|
|
|
- silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
+ --link postgresql:database \
|
|
|
|
|
+ --volumes-from silverpeas-store \
|
|
|
|
|
+ silverpeas
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
If you have to customize the settings of Silverpeas or add, for example, a new database definition, then specify these settings with the Data Volume Container, so that they will be available to the next versions of Silverpeas which will be then configured correctly like your previous Silverpeas installation:
|
|
If you have to customize the settings of Silverpeas or add, for example, a new database definition, then specify these settings with the Data Volume Container, so that they will be available to the next versions of Silverpeas which will be then configured correctly like your previous Silverpeas installation:
|
|
|
|
|
|
|
|
- $ 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/CustomerSettings.xml:/opt/silverpeas/configuration/silverpeas/CustomerSettings.xml \
|
|
|
|
|
- -v /etc/silverpeas/my-datasource.cli:/opt/silverpeas/configuration/jboss/my-datasource.cli \
|
|
|
|
|
- silverpeas \
|
|
|
|
|
- /bin/true
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ 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/CustomerSettings.xml:/opt/silverpeas/configuration/silverpeas/CustomerSettings.xml \
|
|
|
|
|
+ -v /etc/silverpeas/my-datasource.cli:/opt/silverpeas/configuration/jboss/my-datasource.cli \
|
|
|
|
|
+ silverpeas \
|
|
|
|
|
+ /bin/true
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
# Document conversion
|
|
# Document conversion
|
|
|
|
|
|
|
@@ -194,9 +208,11 @@ Some features in Silverpeas (export, preview, content visualization, ...) requir
|
|
|
|
|
|
|
|
Once a Data Volume Container is created for Silverpeas as explained in the section above, you have to link it with the Docker image running LibreOffice as a daemon in order the program have access the documents to convert:
|
|
Once a Data Volume Container is created for Silverpeas as explained in the section above, you have to link it with the Docker image running LibreOffice as a daemon in order the program have access the documents to convert:
|
|
|
|
|
|
|
|
- $ docker run --name libreoffice -d \
|
|
|
|
|
- --volumes-from silverpeas-store \
|
|
|
|
|
- xcgd/libreoffice
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name libreoffice -d \
|
|
|
|
|
+ --volumes-from silverpeas-store \
|
|
|
|
|
+ xcgd/libreoffice
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
Check the port at which the LibreOffice image is listening and then defines it in the Silverpeas configuration. In our example, `xcgd/libreoffice` listens by default the port 8997. The configuration parameters to communicate with LibreOffice are defined by the two following properties:
|
|
Check the port at which the LibreOffice image is listening and then defines it in the Silverpeas configuration. In our example, `xcgd/libreoffice` listens by default the port 8997. The configuration parameters to communicate with LibreOffice are defined by the two following properties:
|
|
|
|
|
|
|
@@ -210,11 +226,13 @@ These properties have to be defined in the Silverpeas global configuration file
|
|
|
|
|
|
|
|
Then the Docker image of Silverpeas can be ran:
|
|
Then the Docker image of Silverpeas can be ran:
|
|
|
|
|
|
|
|
- $ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
- --link postgresql:database \
|
|
|
|
|
- --link libreoffice:libreoffice \
|
|
|
|
|
- --volumes-from silverpeas-store \
|
|
|
|
|
- silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker run --name silverpeas -p 8080:8000 -d \
|
|
|
|
|
+ --link postgresql:database \
|
|
|
|
|
+ --link libreoffice:libreoffice \
|
|
|
|
|
+ --volumes-from silverpeas-store \
|
|
|
|
|
+ silverpeas
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
# Logs
|
|
# Logs
|
|
|
|
|
|
|
@@ -222,7 +240,9 @@ You can follow the activity of Silverpeas by watching the logs generated in the
|
|
|
|
|
|
|
|
The output of Wildfly is redirected into the container standard output and so it can be watched as following:
|
|
The output of Wildfly is redirected into the container standard output and so it can be watched as following:
|
|
|
|
|
|
|
|
- $ docker logs -f silverpeas
|
|
|
|
|
|
|
+```console
|
|
|
|
|
+$ docker logs -f silverpeas
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
# License
|
|
# License
|
|
|
|
|
|