jiriks74/Docker-DocumentServer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Alexey Bannov 2016-06-30 18:10:22 +03:00 committed by GitHub
parent 1125fc0900
commit 5d761b4b58
1 changed files with 57 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -43,7 +43,7 @@ Integrating it with ONLYOFFICE Community Server you will be able to:
* **Swap file**: at least 2 GB * **Swap file**: at least 2 GB
* **HDD**: at least 2 GB of free space * **HDD**: at least 2 GB of free space
* **Distributive**: 64-bit Red Hat, CentOS or other compatible distributive with kernel version 3.8 or later, 64-bit Debian, Ubuntu or other compatible distributive with kernel version 3.8 or later * **Distributive**: 64-bit Red Hat, CentOS or other compatible distributive with kernel version 3.8 or later, 64-bit Debian, Ubuntu or other compatible distributive with kernel version 3.8 or later
* **Docker**: version 1.4.1 or later * **Docker**: version 1.9.0 or later
## Running Docker Image ## Running Docker Image
@ -62,8 +62,8 @@ All the data are stored in the specially-designated directories, **data volumes*
To get access to your data from outside the container, you need to mount the volumes. It can be done by specifying the '-v' option in the docker run command. To get access to your data from outside the container, you need to mount the volumes. It can be done by specifying the '-v' option in the docker run command.
sudo docker run -i -t -d -p 80:80 \ sudo docker run -i -t -d -p 80:80 \
-v /opt/onlyoffice/Logs:/var/log/onlyoffice \ -v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
-v /opt/onlyoffice/Data:/var/www/onlyoffice/Data onlyoffice/documentserver -v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data onlyoffice/documentserver
Storing the data on the host machine allows you to easily update ONLYOFFICE once the new version is released without losing your data. Storing the data on the host machine allows you to easily update ONLYOFFICE once the new version is released without losing your data.
@ -76,7 +76,7 @@ To change the port, use the -p command. E.g.: to make your portal accessible via
### Running ONLYOFFICE Document Server using HTTPS ### Running ONLYOFFICE Document Server using HTTPS
sudo docker run -i -t -d -p 443:443 \ sudo docker run -i -t -d -p 443:443 \
-v /opt/onlyoffice/Data:/var/www/onlyoffice/Data onlyoffice/documentserver -v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data onlyoffice/documentserver
Access to the onlyoffice application can be secured using SSL so as to prevent unauthorized access. While a CA certified SSL certificate allows for verification of trust via the CA, a self signed certificates can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. Below the instructions on achieving this are provided. Access to the onlyoffice application can be secured using SSL so as to prevent unauthorized access. While a CA certified SSL certificate allows for verification of trust via the CA, a self signed certificates can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. Below the instructions on achieving this are provided.
@ -87,8 +87,8 @@ To secure the application via SSL basically two things are needed:
So you need to create and install the following files: So you need to create and install the following files:
/opt/onlyoffice/Data/certs/onlyoffice.key /app/onlyoffice/DocumentServer/data/certs/onlyoffice.key
/opt/onlyoffice/Data/certs/onlyoffice.crt /app/onlyoffice/DocumentServer/data/certs/onlyoffice.crt
When using CA certified certificates, these files are provided to you by the CA. When using self-signed certificates you need to generate these files yourself. Skip the following section if you are have CA certified SSL certificates. When using CA certified certificates, these files are provided to you by the CA. When using self-signed certificates you need to generate these files yourself. Skip the following section if you are have CA certified SSL certificates.
@ -131,14 +131,14 @@ Out of the four files generated above, you need to install the `onlyoffice.key`,
The default path that the onlyoffice application is configured to look for the SSL certificates is at `/var/www/onlyoffice/Data/certs`, this can however be changed using the `SSL_KEY_PATH`, `SSL_CERTIFICATE_PATH` and `SSL_DHPARAM_PATH` configuration options. The default path that the onlyoffice application is configured to look for the SSL certificates is at `/var/www/onlyoffice/Data/certs`, this can however be changed using the `SSL_KEY_PATH`, `SSL_CERTIFICATE_PATH` and `SSL_DHPARAM_PATH` configuration options.
The `/var/www/onlyoffice/Data/` path is the path of the data store, which means that you have to create a folder named certs inside `/opt/onlyoffice/Data/` and copy the files into it and as a measure of security you will update the permission on the `onlyoffice.key` file to only be readable by the owner. The `/var/www/onlyoffice/Data/` path is the path of the data store, which means that you have to create a folder named certs inside `/app/onlyoffice/DocumentServer/data/` and copy the files into it and as a measure of security you will update the permission on the `onlyoffice.key` file to only be readable by the owner.
```bash ```bash
mkdir -p /opt/onlyoffice/Data/certs mkdir -p /app/onlyoffice/DocumentServer/data/certs
cp onlyoffice.key /opt/onlyoffice/Data/certs/ cp onlyoffice.key /app/onlyoffice/DocumentServer/data/certs/
cp onlyoffice.crt /opt/onlyoffice/Data/certs/ cp onlyoffice.crt /app/onlyoffice/DocumentServer/data/certs/
cp dhparam.pem /opt/onlyoffice/Data/certs/ cp dhparam.pem /app/onlyoffice/DocumentServer/data/certs/
chmod 400 /opt/onlyoffice/Data/certs/onlyoffice.key chmod 400 /app/onlyoffice/DocumentServer/data/certs/onlyoffice.key
``` ```
You are now just one step away from having our application secured. You are now just one step away from having our application secured.
@ -158,12 +158,22 @@ Below is the complete list of parameters that can be set using environment varia
## Installing ONLYOFFICE Document Server integrated with Community and Mail Servers ## Installing ONLYOFFICE Document Server integrated with Community and Mail Servers
ONLYOFFICE Document Server is a part of ONLYOFFICE Free Edition that comprises also Community Server and Mail Server. To install them, follow these easy steps: ONLYOFFICE Document Server is a part of ONLYOFFICE Community Edition that comprises also Community Server and Mail Server. To install them, follow these easy steps:
**STEP 1**: Create the 'onlyoffice' network.
```bash
docker network create --driver bridge onlyoffice
```
Than launch containers on it using the 'docker run --net onlyoffice' option:
**STEP 1**: Install ONLYOFFICE Document Server. **STEP 1**: Install ONLYOFFICE Document Server.
```bash ```bash
sudo docker run -i -t -d --name onlyoffice-document-server onlyoffice/documentserver sudo docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-document-server \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
onlyoffice/documentserver
``` ```
**STEP 2**: Install ONLYOFFICE Mail Server. **STEP 2**: Install ONLYOFFICE Mail Server.
@ -172,20 +182,45 @@ For the mail server correct work you need to specify its hostname 'yourdomain.co
To learn more, refer to the [ONLYOFFICE Mail Server documentation](https://github.com/ONLYOFFICE/MailServer "ONLYOFFICE Mail Server documentation"). To learn more, refer to the [ONLYOFFICE Mail Server documentation](https://github.com/ONLYOFFICE/MailServer "ONLYOFFICE Mail Server documentation").
```bash ```bash
sudo docker run --privileged -i -t -d --name onlyoffice-mail-server -p 25:25 -p 143:143 -p 587:587 \ sudo docker run --net onlyoffice --privileged -i -t -d --restart=always --name onlyoffice-mail-server \
-h yourdomain.com onlyoffice/mailserver -p 25:25 -p 143:143 -p 587:587 \
-v /app/onlyoffice/MailServer/data:/var/vmail \
-v /app/onlyoffice/MailServer/data/certs:/etc/pki/tls/mailserver \
-v /app/onlyoffice/MailServer/logs:/var/log \
-v /app/onlyoffice/MailServer/mysql:/var/lib/mysql \
-h yourdomain.com \
onlyoffice/mailserver
``` ```
**STEP 3**: Install ONLYOFFICE Community Server **STEP 3**: Install ONLYOFFICE Community Server
```bash ```bash
sudo docker run -i -t -d -p 80:80 -p 5222:5222 -p 443:443 \ sudo docker run --net onlyoffice -i -t -d -p 80:80 --restart=always --name onlyoffice-community-server \
--link onlyoffice-mail-server:mail_server \ -p 80:80 -p 5222:5222 -p 443:443 \
--link onlyoffice-document-server:document_server \ -v /app/onlyoffice/CommunityServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/CommunityServer/mysql:/var/lib/mysql \
-v /app/onlyoffice/CommunityServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/DocumentServerData \
-e DOCUMENT_SERVER_PORT_80_TCP_ADDR=onlyoffice-document-server \
-e MAIL_SERVER_DB_HOST=onlyoffice-mail-server \
onlyoffice/communityserver onlyoffice/communityserver
``` ```
Alternatively, you can use [docker-compose](https://docs.docker.com/compose/install "docker-compose") to install the whole ONLYOFFICE Free Edition at once. For the mail server correct work you need to specify its hostname 'yourdomain.com'. Assuming you have docker-compose installed, execute the following command: Alternatively, you can use an automatic installation script to install the whole ONLYOFFICE Community Edition at once. For the mail server correct work you need to specify its hostname 'yourdomain.com'.
**STEP 1**: Download the Community Edition Docker script file
```bash
wget http://download.onlyoffice.com/install/opensource-install.sh
```
**STEP 2**: Install ONLYOFFICE Community Edition executing the following command:
```bash
bash opensource-install.sh -md yourdomain.com
```
Or, use [docker-compose](https://docs.docker.com/compose/install "docker-compose"). For the mail server correct work you need to specify its hostname 'yourdomain.com'. Assuming you have docker-compose installed, execute the following command:
```bash ```bash
wget https://raw.githubusercontent.com/ONLYOFFICE/Docker-CommunityServer/master/docker-compose.yml wget https://raw.githubusercontent.com/ONLYOFFICE/Docker-CommunityServer/master/docker-compose.yml
@ -219,6 +254,6 @@ SaaS version: [http://www.onlyoffice.com](http://www.onlyoffice.com "http://www.
## User Feedback and Support ## User Feedback and Support
If you have any problems with or questions about this image, please contact us through a [dev.onlyoffice.org][1]. If you have any problems with or questions about this image, please contact us through [dev.onlyoffice.org][1].
[1]: http://dev.onlyoffice.org [1]: http://dev.onlyoffice.org