Skip to content

Commit 651e481

Browse files
committed
niceups and reorderings (OPS-3108)
Signed-off-by: Thomas Telleis <thomas.telleis@eccenca.com>
1 parent 72afea9 commit 651e481

File tree

1 file changed

+38
-44
lines changed
  • docs/deploy-and-configure/installation/scenario-local-installation

1 file changed

+38
-44
lines changed

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

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -13,69 +13,62 @@ The code examples in this section assumes that you have POSIX-compliant shell (l
1313
- [docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/install/) (v2) installed locally
1414
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed locally
1515
- [jq](https://jqlang.github.io/jq/download/) installed locally
16+
- make - build tools (apt-get install make) installed locally
1617
- At least 4 CPUs and 12GB of RAM (recommended: 16GB) dedicated to docker
1718

1819

1920
## wsl installation and configuration
2021

2122

22-
for all you need to start powershell in admin mode
23+
For all you need to start Powershell started as administrator. Alternatively you can also install a WSL distribution from Microsoft Store.
2324

24-
install wsl
25+
Install WSL, then restart your Windows machine.
2526
```
2627
$ wsl --install
2728
```
28-
then restart windows
2929

30-
all available distributions
30+
List available distributions
3131
```
3232
$ wsl --list --online
3333
```
3434

35-
install a distribution (use the distribution name from the list you got in the step before)
36-
```
37-
$ wsl --install <Distribution>
38-
```
35+
Install a distribution.
36+
Chose from the ```Name``` column.
37+
Here we use a Debian based distribution like Debian or any Ubuntu.
38+
However other Distributions might work as well.
3939

40-
entering the the wsl-machine
4140
```
42-
$ wsl -d <distribution name>
41+
$ wsl --install Debian
4342
```
4443

45-
check if you use wsl version 2 (this is nessessary to use systemd services)
44+
Check if you use wsl version 2 (this is nessessary to use systemd services)
4645
```
4746
$ wsl -l -v
4847
```
4948

50-
install version 2 components (this requires a windows restart)
49+
Install version 2 components (this requires a windows restart)
5150
```
5251
$ dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
5352
```
5453

55-
make sure you enable 'generateHosts = false' in your /etc/hosts file to make sure
56-
that this file wont be overwritten from the host system every time you restart this distribution
57-
58-
to be able to use systemd services and commands create /etc/wsl.conf with
54+
Enter WSL machine
5955
```
60-
[boot]
61-
systemd=true
56+
$ wsl -d Debian
6257
```
6358

64-
if you need to restart your wsl use in powershell:
65-
```
66-
$ wsl --shutdown
67-
```
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.
6861

69-
check if a apache2 service is running
62+
To be able to use systemd services and commands make sure ```/etc/wsl.conf``` is available with this content:
7063
```
71-
$ sudo service apache2 status
64+
[boot]
65+
systemd=true
7266
```
7367

74-
remove the service with:
68+
(Optional) If you need to restart your WSL use in Powershell:
7569
```
76-
$ sudo apt remove apache2
70+
$ wsl --shutdown
7771
```
78-
restart wsl afterwars
7972

8073
(optional) you can create a .wslconfig file under C:\users\<your username> to specify some system resources like:
8174
```
@@ -117,13 +110,13 @@ Check your local environment:
117110
# to the latest one.
118111
119112
$ docker version | grep -i version
120-
Version: 26.1.4
113+
Docker version: 27.5.1, build 9f9e405
121114
122115
# Check docker compose version, should be at least v2.*.*
123116
# update to the latest version if necessary
124117
125118
$ docker compose version
126-
Docker Compose version v2.29.1
119+
Docker Compose version v2.32.4
127120
128121
# login into eccenca docker registry
129122
@@ -148,22 +141,13 @@ To install Corporate Memory, you need to modify your local hosts file (located i
148141
127.0.0.1 docker.localhost
149142
```
150143

151-
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.
152-
153-
```
154-
$ cp YOUR_SE_LICENSE_FILE \
155-
${HOME}/cmem-orchestration-VERSION/licenses/graphdb-se.license
156-
# or
157-
$ cp YOUR_EE_LICENSE_FILE \
158-
${HOME}/cmem-orchestration-VERSION/licenses/graphdb-ee.license
159-
```
160-
161-
Then change the file ```environments/config.env``` to use the correct version:
162-
144+
Corporate Memory uses Ontotext GraphDB triple store as default backend.
145+
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:
163148
```
164-
# Use Free, 'se' or 'ee' or adjust the mountpoint in
165-
# compose/docker-compose.store.graphdb.yaml
166-
GRAPHDB_LICENSE=se
149+
# adapt this line if a license ca be provided
150+
# - "{DEST}/licenses/graphdb.license:/opt/graphdb/dist/conf/graphdb.license"
167151
```
168152

169153
Run the command to clean workspace, pull the images, start the Corporate Memory instance and load initial data:
@@ -264,3 +248,13 @@ ln -sf 2024-07-26_14-15.zip data/backups/latest.zip
264248
265249
```
266250
The full backup is now at `data/backups/latest.zip`.
251+
252+
253+
### Caveats
254+
255+
In case you have problems starting and receive error messages like Port 80 already assigned.
256+
Then check if a apache2 service is running and remove it.
257+
```
258+
$ sudo service apache2 status
259+
$ sudo service stop apache2
260+
```

0 commit comments

Comments
 (0)