Setup:Installation Guide/Docker: Difference between revisions

No edit summary
No edit summary
Line 6: Line 6:


== Overview ==
== Overview ==
The  BlueSpice application consists of a number of different services. To ease installations, they are available as a pre-configured stack at [https://github.com/hallowelt/bluespice-deploy github.com/hallowelt/bluespice-deploy], but they also allow more flexibility, e.g. by providing a simple way to run several services on different machines or to re-use existing services.
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 14: Line 15:
!FARM
!FARM
|-
|-
|<code>bluespice/wiki</code>  
|<code>wiki</code>  
|The main application. It features two main modes: "web", for the connection to the client and "task" for any background processing and administrative purposes.
|The main application. It features two main modes: "web", for the connection to the client and "task" for any background processing and administrative purposes. It comes in different editions (FREE, PRO and FARM).
|YES
|YES
|YES
|YES
|YES
|YES
|-
|-
|<code>bluespice/pdf</code>  
|<code>pdf</code>  
|Allows to create PDF filesfrom wikipages
|Allows to create PDF filesfrom wikipages
|YES
|YES
Line 26: Line 27:
|YES
|YES
|-
|-
|<code>bluespice/search</code>  
|<code>search</code>  
|Allows to perform a fulltext search on the wiki content
|Allows to perform a fulltext search on the wiki content
|YES
|YES
Line 32: Line 33:
|YES
|YES
|-
|-
|<code>bluespice/formula</code>  
|<code>formula</code>  
|Allows to show mathematical and chemical formulas in the wiki content
|Allows to show mathematical and chemical formulas in the wiki content
|NO
|NO
Line 38: Line 39:
|YES
|YES
|-
|-
|<code>bluespice/collabpads</code>  
|<code>collabpads</code>  
|Allows for simultaneous editing of wikipages
|Allows for simultaneous editing of wikipages
|NO
|NO
Line 44: Line 45:
|YES
|YES
|-
|-
|<code>bluespice/diagram</code>  
|<code>collabpads-database</code>
|Stores the data for simultaneous editing sessions.
|NO
|YES
|YES
|-
|<code>diagram</code>  
|Allows to create and edit diagram  images in the wiki content
|Allows to create and edit diagram  images in the wiki content
|NO
|NO
Line 50: Line 57:
|YES
|YES
|-
|-
|<code>bluespice/pagepreview</code>  
|<code>pagepreview</code>  
|Allows to show preview images of wikipages
|Allows to show preview images of wikipages
|YES
|YES
Line 56: Line 63:
|YES
|YES
|-
|-
|<code>bluespice/cache</code>  
|<code>cache</code>  
|Supports application performance
|Supports application performance
|YES
|YES
|YES
|YES
|YES
|YES
|-
|<code>database</code>
|Stores the application data
|YES
|YES
|YES
|-
|<code>proxy</code>
|Manages the clients's access to the different services. Provides SSL capabilities
|YES
|YES
|YES
|-
|<code>kerberos-proxy</code>
|Allows to set up a Kerberos-based authentication mechanism
|NO
|OPTIONAL
|OPTIONAL
|}
|}
Generic services that can be substituted by already available ones are
* database →Can be replaces by any version compatible MariaDB / MySQL server
* collabpads-database →Can be replaces by any version compatible MongoDB server
* cache →Can be replaced by any version compatible MemcacheD server
* search →Can be replaced by any version compatible OpenSearch server
* proxy -> Can be replaced by any appropriately configured Proxy server / Loadbalancer

Revision as of 11:35, 22 July 2024

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


Overview

The BlueSpice application consists of a number of different services. To ease installations, they are available as a pre-configured stack at github.com/hallowelt/bluespice-deploy, but they also allow more flexibility, e.g. by providing a simple way to run several services on different machines or to re-use existing services.

Service name Description FREE PRO FARM
wiki The main application. It features two main modes: "web", for the connection to the client and "task" for any background processing and administrative purposes. It comes in different editions (FREE, PRO and FARM). YES YES YES
pdf Allows to create PDF filesfrom wikipages YES YES YES
search Allows to perform a fulltext search on the wiki content YES YES YES
formula Allows to show mathematical and chemical formulas in the wiki content NO YES YES
collabpads Allows for simultaneous editing of wikipages NO YES YES
collabpads-database Stores the data for simultaneous editing sessions. NO YES YES
diagram Allows to create and edit diagram images in the wiki content NO YES YES
pagepreview Allows to show preview images of wikipages YES YES YES
cache Supports application performance YES YES YES
database Stores the application data YES YES YES
proxy Manages the clients's access to the different services. Provides SSL capabilities YES YES YES
kerberos-proxy Allows to set up a Kerberos-based authentication mechanism NO OPTIONAL OPTIONAL

Generic services that can be substituted by already available ones are

  • database →Can be replaces by any version compatible MariaDB / MySQL server
  • collabpads-database →Can be replaces by any version compatible MongoDB server
  • cache →Can be replaced by any version compatible MemcacheD server
  • search →Can be replaced by any version compatible OpenSearch server
  • proxy -> Can be replaced by any appropriately configured Proxy server / Loadbalancer



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