Cookie consent settingsAccept all
  • Skip to header bar
  • Skip to main navigation
  • Skip to page tools
  • Skip to work area
  • New process
  • Overview
    • Files
    • Processes
    • Ratings
    • Recommendations
    • WikiExplorer
    • Workflows
  • Login
Main navigation contains tabs, main links and MediaWiki sidebar
Entrypoints
  • Main Page
  • Pages
  • Books
  • Blogs
  • Recent changes
Quick Links
  • All topics
  • Video-Tutorials
  • Templates download
Documentation
  • Security Advisories
  • Installation
  • Releases
  • Software catalog
  • Trust & Safety
Books
  • User manual
  • Admin manual
  • Semantic MediaWiki basics
Participate
  • BlueSpice community
You are viewing an old version of this page. Return to the latest version.
This is the version of 27 September 2024, 14:47 by WikiSysop
PreviousNext
  • Setup
  • Installation Guide
    • Docker
      Last edited 2 months ago
      by Hua Jing

      Docker

      Revision as of 14:47, 27 September 2024 by WikiSysop (talk | contribs)
      (diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
      Migration from 4.4With BlueSpice 4.5 there were important changes to the container portfolio:
      1. There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
      2. 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.

      Self-signed certificatesFor using self-signend Certificates please put <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.



      To submit feedback about this documentation, visit our community forum.

      Retrieved from "https://en.wiki5.bluespice.com/w/index.php?title=Setup:Installation_Guide/Docker&oldid=10048"
      No categories assignedEdit
      Page actions and tools navigaiton contains tabs, toolbox and actions
      Actions
      • Refresh
      • Copy URL
      • E-Mail
      • QR code
      Details
      • View history
      • Page information
      • Browse properties
      • ... all actions
      • Privacy policy
      • Terms of service
      • Disclaimer
      • Imprint
      • Accessibility
      • About
      • Edit preview settings
      • Powered by MediaWiki
      • Powered by BlueSpice
      • Powered by Semantic MediaWiki
      • Creative Commons License