Merge pull request #182 from eccenca/feature/codeblock_adjustments

Feature/codeblock adjustments

Author: rpietzsch

docs/deploy-and-configure/installation/scenario-local-installation/index.md

@@ -19,53 +19,53 @@ The code examples in this section assumes that you have POSIX-compliant shell (l
 
 Open a terminal window, create a directory, copy and extract docker orchestration there.
 
-```
+```bash
 # Create eccenca-corporate-memory directory in your ${HOME} and set as a 
 # working dir.
 
-$ mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
+mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
 
 # download the Corporate Memory orchestration distribution
-$ curl https://releases.eccenca.com/docker-orchestration/latest.zip \
+curl https://releases.eccenca.com/docker-orchestration/latest.zip \
     > cmem-orchestration.zip
 
 # unzip the orchestration and move the unzipped directory 
-$ unzip cmem-orchestration.zip
-$ rm cmem-orchestration.zip
-$ mv cmem-orchestration-v* cmem-orchestration
-$ cd cmem-orchestration
-$ git init && git add . && git commit -m "stub"
+unzip cmem-orchestration.zip
+rm cmem-orchestration.zip
+mv cmem-orchestration-v* cmem-orchestration
+cd cmem-orchestration
+git init && git add . && git commit -m "stub"
 ```
 
 Check your local environment:
 
-```
+```bash
 # Run the following command to check your docker server version.
 # To have the current security patches, always update your docker version
 # to the latest one.
 
-$ docker version | grep -i version
-Version:    26.1.4
+docker version | grep -i version
+# Version:    26.1.4
 
 # Check docker compose version, should be at least v2.*.*
 # update to the latest version if necessary
 
-$ docker compose version
-Docker Compose version v2.29.1
+docker compose version
+# Docker Compose version v2.29.1
 
 # login into eccenca docker registry
 
-$ docker login docker-registry.eccenca.com
-Username: yourusername
-Password:
-Login Succeeded
+docker login docker-registry.eccenca.com
+# Username: yourusername
+# Password:
+# Login Succeeded
 ```
 
 ## Installation
 
 To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows:
 
-```
+```bash
 ##
 # Host Database
 #
@@ -78,33 +78,33 @@ To install Corporate Memory, you need to modify your local hosts file (located i
 
 Corporate Memory uses Ontotext GraphDB triple store as default backend. Graphdb is available as free version and does not requires a license. If you have a license for graphdb you can copy the file to the ```license```folder inside Corporate Memory's root folder.
 
-```
-$ cp YOUR_SE_LICENSE_FILE \
-    ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-se.license
+```bash
+cp YOUR_SE_LICENSE_FILE \
+  ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-se.license
 # or
-$ cp YOUR_EE_LICENSE_FILE \
-    ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-ee.license
+cp YOUR_EE_LICENSE_FILE \
+  ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-ee.license
 ```
 
 Then change the file ```environments/config.env``` to use the correct version:
 
-```
+```bash
 # Use Free, 'se' or 'ee' or adjust the mountpoint in 
 # compose/docker-compose.store.graphdb.yaml
 GRAPHDB_LICENSE=se
 ```
 
 Run the command to clean workspace, pull the images, start the Corporate Memory instance and load initial data:
 
-```
+```bash
 # Pulling the images will take time
 
-$ make clean-pull-start-bootstrap
+make clean-pull-start-bootstrap
 ```
 
 You should see the output as follows:
 
-```
+```bash
 make[1]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration'
 The target cleans up everything and esp. REMOVES ALL YOUR DATA. Do you want to continue?
 
@@ -160,28 +160,28 @@ After successful login, you will see Corporate Memory interface. You can now pro
 
 To create a backup you have to prepare the backup folders. Make sure these folders exists and have write permissions. Run this:
 
-```
+```bash
 # assuming you are currently in the the cmem-orchestration folder
-$ mkdir -p data/backups/graphs data/backups/workspace
-$ chmod 777 data/backups/graphs data/backups/workspace
+mkdir -p data/backups/graphs data/backups/workspace
+chmod 777 data/backups/graphs data/backups/workspace
 
-$ make backup
+make backup
 mkdir -p data/backups/keycloak
-Started Keycloak database backup to data/backups/keycloak/keycloak.sql ...
-Finished Keycloak database backup.
+# Started Keycloak database backup to data/backups/keycloak/keycloak.sql ...
+# Finished Keycloak database backup.
 mv data/backups/keycloak/keycloak.sql data/backups/keycloak/2024-07-26_14-15.sql
 ln -sf 2024-07-26_14-15.sql data/backups/keycloak/latest.sql
 mkdir -p data/backups/workspace
 docker compose run -i --rm --env "OAUTH_CLIENT_SECRET=c8c12828-000c-467b-9b6d-2d6b5e16df4a" --volume /home/ttelleis/cmem-dist/cmem-orchestration/data:/data --volume /home/ttelleis/cmem-dist/cmem-orchestration/conf/cmemc/cmemc.ini:/config/cmemc.ini cmemc -c cmem admin workspace export /data/backups/workspace/2024-07-26_14-15.zip
-Export workspace to /data/backups/workspace/2024-07-26_14-15.zip ... done
+# Export workspace to /data/backups/workspace/2024-07-26_14-15.zip ... done
 ln -sf 2024-07-26_14-15.zip data/backups/workspace/latest.zip
 mkdir -p data/backups/python-packages
 zip -r data/backups/python-packages/2024-07-26_14-15.zip data/python-packages
   adding: data/python-packages/ (stored 0%)
 ln -sf 2024-07-26_14-15.zip data/backups/python-packages/latest.zip
 mkdir -p data/backups/graphs
 docker compose run -i --rm --env "OAUTH_CLIENT_SECRET=c8c12828-000c-467b-9b6d-2d6b5e16df4a" --volume /home/ttelleis/cmem-dist/cmem-orchestration/data:/data --volume /home/ttelleis/cmem-dist/cmem-orchestration/conf/cmemc/cmemc.ini:/config/cmemc.ini cmemc -c cmem admin store export /data/backups/graphs/2024-07-26_14-15.zip
-Exporting graphs backup to /data/backups/graphs/2024-07-26_14-15.zip ... done
+# Exporting graphs backup to /data/backups/graphs/2024-07-26_14-15.zip ... done
 ln -sf 2024-07-26_14-15.zip data/backups/graphs/latest.zip
 zip -r data/backups/2024-07-26_14-15.zip data/backups/keycloak/2024-07-26_14-15.sql data/backups/workspace/2024-07-26_14-15.zip data/backups/graphs/2024-07-26_14-15.zip data/backups/python-packages/2024-07-26_14-15.zip
   adding: data/backups/keycloak/2024-07-26_14-15.sql (deflated 82%)

docs/deploy-and-configure/installation/scenario-redhat-enterprise-linux-7/index.md

@@ -17,7 +17,7 @@ This page describes a `docker compose` based orchestration running on RedHat Ent
 
 Create a working directory for this scenario and inside the working directory `Vagrantfile` with the following contents:
 
-```bash linenums="1"
+```ruby
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
@@ -47,8 +47,8 @@ end
 
 Spin up the virtual machine:
 
-```bash linenums="1"
-$ vagrant up
+```ruby
+vagrant up
 Bringing machine 'rhel7' up with 'virtualbox' provider...
 ==> rhel7: Importing base box 'generic/rhel7'...
 ==> rhel7: Matching MAC address for NAT networking...
@@ -86,7 +86,7 @@ Bringing machine 'rhel7' up with 'virtualbox' provider...
 
 Now you can connect to the virtual machine using `~/.vagrant.d/insecure_private_key` ssh key:
 
-```bash linenums="1"
+```bash
 # add vagrant ssh key to your keychain
 ssh-add ~/.vagrant.d/insecure_private_key
 
@@ -99,7 +99,7 @@ ssh [email protected]
 
 Install the necessary software Inside the virtual machine and download the Corporate Memory orchestration from [releases.eccenca.com](http://releases.eccenca.com/):
 
-```bash linenums="1"
+```bash
 # switch to superuser
 sudo su
 
@@ -135,8 +135,8 @@ chcon -Rt svirt_sandbox_file_t /opt/corporate-memory
 
 Create `/opt/corporate-memory/environments/prod.env` file with the following contents:
 
-```bash linenums="1"
-#!/bin/bash linenums="1"
+```bash
+#!/bin/bash
 
 DEPLOYHOST=corporate.memory
 DEPLOYPROTOCOL=https
@@ -148,21 +148,21 @@ APACHE_CONFIG=default.ssl.conf
 
 Login into eccenca docker registry:
 
-```bash linenums="1"
+```bash
 docker login docker-registry.eccenca.com
 ```
 
 Provide a stardog license or request a trial license:
 
-```bash linenums="1"
+```bash
 # check validity of your license
-$ make stardog-license-check
+make stardog-license-check
 docker run -it --rm --name stardog-license-check -v data:/data -v /opt/corporate-memory//conf/stardog/stardog-license-key.bin:/data/stardog-license-key.bin docker-registry.eccenca.com/complexible-stardog:v7.2.0-1 stardog-admin license info /data/stardog-license-key.bin
 The license is invalid: java.io.EOFException
 make: *** [custom.dist.Makefile:5: stardog-license-check] Error 1
 
 # request stardog trial license
-$ make stardog-license-request
+make stardog-license-request
 docker run -it --rm --name stardog-license-check -v data:/data -v /opt/corporate-memory//conf/stardog/stardog-license-key.bin:/data/stardog-license-key.bin docker-registry.eccenca.com/complexible-stardog:v7.2.0-1 stardog-admin license request --force --output /data/stardog-license-key.bin
 Thank you for downloading Stardog.
 A valid license was not found in /data.
@@ -199,7 +199,7 @@ Email validated. You now have a 60-day Stardog trial license. Starting Stardog..
 Thank you!
 
 # check the license again
-$ make stardog-license-check
+make stardog-license-check
 docker run -it --rm --name stardog-license-check -v data:/data -v /opt/corporate-memory//conf/stardog/stardog-license-key.bin:/data/stardog-license-key.bin docker-registry.eccenca.com/complexible-stardog:v7.2.0-1 stardog-admin license info /data/stardog-license-key.bin
 Licensee: Stardog Trial User ([email protected]), Stardog Union
 Version: Stardog *
@@ -212,7 +212,7 @@ Quantity: 3
 
 Finally deploy the Corporate Memory instance:
 
-```bash linenums="1"
+```bash
 # create local truststore
 CONFIGFILE=environments/prod.env make buildTrustStore
 
@@ -226,7 +226,7 @@ You have successfully deployed a Corporate Memory instance.
 
 On your localhost where you are running VirtualBox, modify /etc/hosts file:
 
-```bash linenums="1"
+```bash
 echo "10.10.10.10 corporate.memory" >> /etc/hosts
 ```