- There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
- The "distributed-services" setup for PRO and FARM edition has been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the migration guide
Installation
Get "docker-compose" files from https://bluespice.com/de/download/
wget https://bluespice.com/filebase/docker-deployment-script \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose
| Filename | Type | obligatory | Comment |
|---|---|---|---|
bluespice-deploy
|
bash-script | false | Wrapper for general start-up of needed Containers |
bluespice-prepare
|
bash-script | false | Prepare Folder and Permissions before first start also creates service |
bluespice.service
|
service-script | false | Porper handling of the Containers on reboot |
docker-compose.main.yml
|
yml | true | Main Services/ run by bluespice-deploy |
docker-compose.persistent-data-services.yml
|
yml | true | Database and Search/ run by bluespice-deploy |
docker-compose.stateless-services.yml
|
yml | false but strongly recommended for full functionality | PDF-Renderer/Cache/Formula/Diagram-Service |
docker-compose.proxy.yml
|
yml | false but recommended | Proxy Service |
docker-compose.proxy-letsencrypt.yml
|
yml | false | Additional autorenewal service for LetsEncrypt-Certificates |
docker-compose.kerberos-proxy.yml
|
yml | false | Additional Proxy for Kerberos-Authenication |
The bluespice-deploy script starts the first four yml files by default.
% cat bluespice-deploy docker compose \ -f docker-compose.main.yml \ -f docker-compose.persistent-data-services.yml \ -f docker-compose.stateless-services.yml \ -f docker-compose.proxy.yml \ $@
To add additional services either change script or just add them by hand:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -d
For bluespice.service please do also either expand the line in the etc/systemd/system/bluespice.service:
[Unit] Description=BlueSpice-Docker startup routinie Requires=docker.service After=docker.service [Service] WorkingDirectory=<WORKDIR> ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans ExecStop=bluespice-deploy down TimeoutStartSec=0 Restart=on-failure StartLimitInterval=120 StartLimitBurst=2 [Install] WantedBy=multi-user.target%
Create .env file according to existing or state-to-be installation.
Example:
DATADIR=/data/bluespice VERSION=4.5 EDITION=pro BACKUP_HOUR=04 WIKI_NAME=BlueSpice WIKI_LANG=en WIKI_PASSWORDSENDER=no-reply@wiki.company.local WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local WIKI_HOST=wiki.company.local WIKI_PORT=443 WIKI_PROTOCOL=https DB_USER=bluespice DB_PASS=... DB_HOST=database DB_NAME=bluespice DB_PREFIX= SMTP_HOST=mail.company.local SMTP_PORT=25 SMTP_USER=... SMTP_PASS=... SMTP_ID_HOST=...
Run bluespice-prepare script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.
Additional options
SSL certificates
For using Let's Encrypt Certificates just add docker-compose.proxy-letsencrypt.yml in your bluespice-deploy file.
<bluespice-wiki.com>.crt and <bluespice-wiki.com>.key with the exact name of your Wikis URL in ${VOLUMES_DIR}/nginx/certs
If activating SSL after first creation of wiki please change $wgServer in ${VOLUMES_DIR}/bluespice-data/LocalSettings.php
to https://bluespice-wiki.com
also link your certificate to the bluespice-container in your docker-compose.yml-File:
- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro
Please restart containers after changing/adding SSL files.
