Last edited 2 years ago
by Demo writer

YourCompany/Documentation: Difference between revisions

(Created page with "{{CustomTOC|limit=3}} <bs:universalexport:pagebreak /> ==Management Summary== YourCompany has organizational wikis. The organization wikis vary in size, some have a size of...")
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
Line 1: Line 1:
{{CustomTOC|limit=3}}
{{TOClimit|limit=2}}
<bs:universalexport:pagebreak />
<bs:universalexport:pagebreak />
==Management Summary==
==Management Summary==

Revision as of 14:39, 23 March 2022

Page break

Management Summary

YourCompany has organizational wikis.

The organization wikis vary in size, some have a size of only a few pages. About 5 wikis have a much larger size. All model company wikis have a total of about 400 users.

The following procedure has been defined:

  • Users are currently managed by SAML. In addition, access to the individual wikis should be controlled via SAML.

Page break

Server Infrastructure

Server environment

Server Server name URL Configuration
Production System rz14.yourcompany.local https://wiki.yourcompany.de/ Ubuntu 16.04.

8 CPUs

32 GB RAM

Development System rz14.yourcompany.local https://wiki-a.yourcompany.de Ubuntu 16.04.

8 CPUs

32 GB RAM

Setup BlueSpice pro with WikiFarm

BlueSpice pro Services:

Services for the operation of BlueSpice pro:
  • Webserver (Apache) with PHP
  • Database (MariaDB)
Additonal Services:
Service required for
NodeJS/Parsoid VisualEditor
NodeJS/PhantomJS generating screenshots (e.g. recent changes)
Java Application Server (Jetty)/ Tomcat PDF export
Java Application Server (Jetty)/ VisualDiff compare versions of a page
Java Application Server (Jetty)/ TeX math formulas
Search Server (ElasticSearch) search
SVG-Renderer (Inkscape) .svg
Python/Pygmentize syntax highlighting source code in pages

Scheme Docker Container

drawio: Structure of the docker container

Page break

Production Wiki

History / Important Deployments

Protocol by Horst Schreiber
First installation 2017-04-02
Update to current codebase 3.0.0 2018-11-26
Update to 3.0.1 2019-03-27
Update


Access

Remote Access VPN -> SSH
ID a_exNNNNN
Username for SSH ICA\a_exNNNNN


Installed programs (applications)

URL https://wiki.yourcompany.com
Domains
  • wiki.yourcompany.com
  • wikidocs.yourcompany.com
Server name rz14.yourcompany.local
Operating System Ubuntu 16.04.
BlueSpice Version 3.0.1 per WikiFarm
MediaWiki Version 1.31.1
Deployment package Docker
Path to Docker files /data/bluespice/bluespice
Authentication SAML.php
Notes Group assignment to instances in 099-AdditionalPermissions.php


Please note for updates

Since it is currently not possible to set the permissions properly, the delete permission has been withdrawn from the editor DefaultSettings.php.


Docker

Starting Docker

docker run -d -v /data/bluespice/certificates:/etc/apache2/ssl  -v 
/data/bluespice/bluespice/099-AdditionalPermissions.php:/var/www/bluespice/w/settings.d/099-
    AdditionalPermissions.php -v 
/data/bluespice/database:/var/lib/mysql -v 
/data/bluespice/elasticsearch:/var/lib/elasticsearch -v 
/data/bluespice/bluespice:/opt/bluespice-docker -v /data/bluespice/backup:/backup -v 
/data/backups-mediawiki:/import -e "TZ=Europe/musterfirma"  -lCE -t -p 80:80 -p 443:443 -p 8000:8000 
    -p 8001:8001 1d85e6a800e9

Docker IP

cat /etc/doc ker/daemon.json
{
        "bip": "172.19.10.1/24",
        "fixed-cidr": "172.19.10.1/24"
}


Backup / Cronjobs

Cronjobs

runJobs daily

Backup

BackupDatabases daily


Services

Database

Programm MariaDB
Version 10.1.37

PHP

Version 7.0.30

Jetty

Version 9

Caching

opcache
memcached

Webserver

Programm Apache
Version 2.4.18
Page break

Development Wiki

Belongs to: YourCompany
First installation: 2022-01-04
Contract start: 2021-12-17
Minimum contract period: 2 Years
Contract type: Subscription
Performance level: Standard with WikiFarm and Development
Account manager: Doe, John
Last update:
Short description Testsystem: BlueSpice 4 pro with WikiFarm and Development

History / Important Deployments

Protocol by Sarah Naumann
First Installation 2018-11-26
Update to 3.0.1 2019-03-26
Update

Access

Remote Access VPN -> SSH
ID a_exNNNNN
Username for SSH ICA\a_exNNNNN

Installed programs (applications)

URL https://wiki.yourcompany.com
Domains
  • wiki.yourcompany.com
  • wikidoc.yourcompany.com
Server Name rz17.musterfirma.local
Operating System Ubuntu 16.04.
BlueSpice Version 3.0.1 per WikiFarm
MediaWiki Version 1.31.1
Deployment Package Docker
Path to Docker files /data/bluespice/bluespice
Authentication SAML.php
Notes Group assignment to instances in 099-AdditionalPermissions.php

Please note for updates

Since it is currently not possible to set the permissions properly, the delete permission has been withdrawn from the editor DefaultSettings.php.

Docker

Starting Docker

docker run -d -v /data/bluespice/certificates:/etc/apache2/ssl  -v 
/data/bluespice/bluespice/099-AdditionalPermissions.php:/var/www/bluespice/w/settings.d/
	099-AdditionalPermissions.php -v 
/data/bluespice/database:/var/lib/mysql -v 
/data/bluespice/elasticsearch:/var/lib/elasticsearch -v 
/data/bluespice/bluespice:/opt/bluespice-docker -v /data/bluespice/backup:/backup -v 
/data/backups-mediawiki:/import -e "TZ=Europe/Berlin"  -lCE -t -p 80:80 -p 443:443 
	-p 8000:8000 -p 8001:8001 1d85e6a800e9

Docker IP

cat /etc/doc ker/daemon.json
{
        "bip": "172.19.10.1/24",
        "fixed-cidr": "172.19.10.1/24"
}

Backup / Cronjobs

Cronjobs

runJobs daily

Backup

BackupDatabases daily

Services

Database

Program MariaDB
Version 10.1.37

PHP

Version 7.0.30

Jetty

Version 9

Caching

opcache
memcached

Webserver

Program Apache
Version 2.4.18
Page break

Authentication and Security Levels

SAML/Prod

The following domains are all connected to SAML:

  • wiki.yourcompany.com = Main Instance = WikiFarm Management
  • wiki.yourcompany.com redirects to wiki.yourcompany.com/yourcompany= YourCompany Wiki
  • wikidocs.yourcompany.com redirects to wiki.yourcompany.com/yourcompany with local login


Security levels of wikis

* = (all) = applies to every visitor of the wiki, including those who do not log in.

Public

permissions
user group login required sys admin wiki maintain admin editor reader
[...]_Admin x x x x x
* --- --- --- x x

Protected

permissions
user group login required sys admin wiki maintain admin editor reader
[...]_Admin x x x x x
[...]_Editeren x --- --- x x
* --- --- --- --- x

Private

permissions
user group login required sys admin wiki maintain admin editor reader
[...]_Admin x x x x x
[...]_Editeren x --- --- x x
[...]_Lezen x --- --- --- x
* --- --- --- --- ---

Admin

permissions
user group login required sys admin wiki maintain admin editor reader
[...]_Admin x x x x x
* --- --- --- --- ---


URL

If the URL of a wiki does not exist (or there is a letter error because of case-sensitivity), the user is currently redirected to the farm management. Depending on the authorization level, the user might not have access. It is possible to redirect the user to a page of another instance. However, this can only be done once. Redirects always link to the same instance. On the target page you could, for example, store an overview of operating wikis.

Discussions