Skip to content

Commit ea5f977

Browse files
committed
small tweaks, add fenced-code-lang
1 parent 651e481 commit ea5f977

File tree

1 file changed

+51
-45
lines changed
  • docs/deploy-and-configure/installation/scenario-local-installation

1 file changed

+51
-45
lines changed

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

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,76 +16,81 @@ The code examples in this section assumes that you have POSIX-compliant shell (l
1616
- make - build tools (apt-get install make) installed locally
1717
- At least 4 CPUs and 12GB of RAM (recommended: 16GB) dedicated to docker
1818

19-
2019
## wsl installation and configuration
2120

22-
23-
For all you need to start Powershell started as administrator. Alternatively you can also install a WSL distribution from Microsoft Store.
21+
For all you need to start Powershell started as administrator.
22+
Alternatively you can also install a WSL distribution from Microsoft Store.
2423

2524
Install WSL, then restart your Windows machine.
26-
```
27-
$ wsl --install
25+
26+
```shell
27+
wsl --install
2828
```
2929

3030
List available distributions
31-
```
32-
$ wsl --list --online
31+
32+
```shell
33+
wsl --list --online
3334
```
3435

35-
Install a distribution.
36-
Chose from the ```Name``` column.
36+
Install a distribution.
37+
Chose from the `Name` column.
3738
Here we use a Debian based distribution like Debian or any Ubuntu.
3839
However other Distributions might work as well.
3940

40-
```
41-
$ wsl --install Debian
41+
```shell
42+
wsl --install Debian
4243
```
4344

4445
Check if you use wsl version 2 (this is nessessary to use systemd services)
45-
```
46-
$ wsl -l -v
46+
47+
```shell
48+
wsl -l -v
4749
```
4850

4951
Install version 2 components (this requires a windows restart)
50-
```
51-
$ dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
52+
53+
```shell
54+
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
5255
```
5356

5457
Enter WSL machine
55-
```
56-
$ wsl -d Debian
58+
59+
```shell
60+
wsl -d Debian
5761
```
5862

59-
Enable ```generateHosts = false``` in your ```/etc/hosts``` file
60-
to make sure that this file won't be overwritten from the host system on every restart.
63+
Enable `generateHosts = false` in your `/etc/hosts` file to make sure that this file won't be overwritten from the host system on every restart.
6164

62-
To be able to use systemd services and commands make sure ```/etc/wsl.conf``` is available with this content:
63-
```
65+
To be able to use systemd services and commands make sure `/etc/wsl.conf` is available with this content:
66+
67+
```shell
6468
[boot]
6569
systemd=true
6670
```
6771

6872
(Optional) If you need to restart your WSL use in Powershell:
69-
```
70-
$ wsl --shutdown
71-
```
7273

73-
(optional) you can create a .wslconfig file under C:\users\<your username> to specify some system resources like:
74+
```shell
75+
wsl --shutdown
7476
```
77+
78+
(optional) you can create a `.wslconfig` file under `C:\users\<your username>` to specify some system resources like:
79+
80+
```shell
7581
[wsl2]
7682
memory=16GB # restrict ram wsl can use
7783
processors=4 # restrict cpu-cores
7884
swap=8GB # set swap size
7985
swapFile=C:/Users/<your username>/wsl/Debianswap.vhdx # location to swap-file
8086
```
8187

82-
8388
## Setup & Check Installation Environment
8489

8590
Open a terminal window, create a directory, copy and extract docker orchestration there.
8691

87-
```
88-
# Create eccenca-corporate-memory directory in your ${HOME} and set as a
92+
```shell
93+
# Create eccenca-corporate-memory directory in your ${HOME} and set as a
8994
# working dir.
9095

9196
$ mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
@@ -94,7 +99,7 @@ $ mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
9499
$ curl https://releases.eccenca.com/docker-orchestration/latest.zip \
95100
> cmem-orchestration.zip
96101

97-
# unzip the orchestration and move the unzipped directory
102+
# unzip the orchestration and move the unzipped directory
98103
$ unzip cmem-orchestration.zip
99104
$ rm cmem-orchestration.zip
100105
$ mv cmem-orchestration-v* cmem-orchestration
@@ -104,7 +109,7 @@ $ git init && git add . && git commit -m "stub"
104109

105110
Check your local environment:
106111

107-
```
112+
```shell
108113
# Run the following command to check your docker server version.
109114
# To have the current security patches, always update your docker version
110115
# to the latest one.
@@ -130,7 +135,7 @@ Login Succeeded
130135

131136
To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows:
132137

133-
```
138+
```shell
134139
##
135140
# Host Database
136141
#
@@ -143,24 +148,25 @@ To install Corporate Memory, you need to modify your local hosts file (located i
143148

144149
Corporate Memory uses Ontotext GraphDB triple store as default backend.
145150
Graphdb is available as free version and does not requires a license.
146-
If you have a license for Ontotext GraphDB you can copy the file to the ```license```folder inside Corporate Memory's root folder.
147-
Then edit the file ```compose/docker-compose.store.graphdb.yml``` and adjust to fit your filename like this:
148-
```
151+
If you have a license for Ontotext GraphDB you can copy the file to the `license`folder inside Corporate Memory's root folder.
152+
Then edit the file `compose/docker-compose.store.graphdb.yml` and adjust to fit your filename like this:
153+
154+
```shell
149155
# adapt this line if a license ca be provided
150156
# - "{DEST}/licenses/graphdb.license:/opt/graphdb/dist/conf/graphdb.license"
151157
```
152158

153159
Run the command to clean workspace, pull the images, start the Corporate Memory instance and load initial data:
154160

155-
```
161+
```shell
156162
# Pulling the images will take time
157163

158164
$ make clean-pull-start-bootstrap
159165
```
160166

161167
You should see the output as follows:
162168

163-
```
169+
```shell
164170
make[1]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration'
165171
The target cleans up everything and esp. REMOVES ALL YOUR DATA. Do you want to continue?
166172

@@ -206,17 +212,17 @@ Run make logs to see log output
206212

207213
Open your browser and navigate to <http://docker.localhost>
208214

209-
| account | password | description |
210-
| ------- | -------- | ------------------------------------------------------------------------------------------- |
211-
| `admin` | `admin` | Is member of the global admin group (can see and do anything) |
215+
| account | password | description |
216+
| ------- | -------- | ----------- |
217+
| `admin` | `admin` | Is member of the global admin group (can see and do anything) |
212218

213219
After successful login, you will see Corporate Memory interface. You can now proceed to the :arrow_right:[Getting Started](../../../getting-started/index.md) section.
214220

215221
### Backup
216222

217223
To create a backup you have to prepare the backup folders. Make sure these folders exists and have write permissions. Run this:
218224

219-
```
225+
```shell
220226
# assuming you are currently in the the cmem-orchestration folder
221227
$ mkdir -p data/backups/graphs data/backups/workspace
222228
$ chmod 777 data/backups/graphs data/backups/workspace
@@ -245,16 +251,16 @@ zip -r data/backups/2024-07-26_14-15.zip data/backups/keycloak/2024-07-26_14-15.
245251
adding: data/backups/graphs/2024-07-26_14-15.zip (stored 0%)
246252
adding: data/backups/python-packages/2024-07-26_14-15.zip (stored 0%)
247253
ln -sf 2024-07-26_14-15.zip data/backups/latest.zip
248-
249254
```
250-
The full backup is now at `data/backups/latest.zip`.
251255

256+
The full backup is now at `data/backups/latest.zip`.
252257

253258
### Caveats
254259

255260
In case you have problems starting and receive error messages like Port 80 already assigned.
256261
Then check if a apache2 service is running and remove it.
257-
```
258-
$ sudo service apache2 status
259-
$ sudo service stop apache2
262+
263+
```shell
264+
sudo service apache2 status
265+
sudo service stop apache2
260266
```

0 commit comments

Comments
 (0)