1
1
# How to install and run
2
2
3
- You can start molgenis-emx2:
3
+ MOLGENIS EMX2 can be started in multiple ways:
4
+ * using Docker Compose
5
+ * using Java and PostgreSQL
6
+ * using Kubernetes
4
7
5
- * using docker compose
6
- * using java commandline + postgresql
7
- * using kubernetes
8
+ ## Using Docker Compose
8
9
9
- Details below:
10
+ Prerequisites:
11
+ * Docker Compose
10
12
11
- ## Using docker compose
12
-
13
- * Install [ Docker compose] ( https://docs.docker.com/compose/install/ ) .
13
+ Steps:
14
14
* Download
15
15
molgenis-emx2 <a href =" https://raw.githubusercontent.com/mswertz/molgenis-emx2/master/docker-compose.yml " download >
16
16
docker-compose.yml</a > file
17
- * In directory with docker-compose.yml run:
17
+ * In the directory containing the docker-compose.yml file run:
18
18
19
- ```
20
- docker-compose up
21
- ```
19
+ ` docker-compose up `
22
20
23
- To update to latest release, run:
21
+ * To update to the latest release, run:
24
22
25
- ``` console
26
- docker-compose pull
27
- ```
23
+ ` docker-compose pull `
28
24
29
- Stop by typing ctrl+c.
30
25
31
- N.B .
26
+ Stop the execution of the process by pressing CTRL+C .
32
27
33
- * because postgres starts slow, emx2 will restart 2-4 times because of 'ConnectException: Connection refused'. This is
34
- normal.
35
- * the data of postgresql will be stored in 'psql_data' folder. Remove this folder you want a clean start .
36
- * if you want
37
- particular [ molgenis-emx2 version] ( https://hub.docker.com/repository/registry-1.docker.io/mswertz/emx2/tags?page=1 )
38
- then add version in docker-compose.yml file ' molgenis/molgenis-emx2: version '
28
+ Note:
29
+ * because PostgreSQL starts slowly EMX2 will restart 2-4 times because of 'ConnectException: Connection refused'. This is
30
+ expected behaviour .
31
+ * the data of the PostgreSQL database will be stored in 'psql_data' folder. Remove this folder you want a clean start.
32
+ * if you want to use a specific [ molgenis-emx2 version] ( https://hub.docker.com/repository/registry-1.docker.io/mswertz/emx2/tags?page=1 )
33
+ add the version number in the docker-compose.yml file with the key ` molgenis/molgenis-emx2:version `
39
34
40
- ## Using java and your own postgresql
35
+ ## Using Java and your local PostgreSQL database
41
36
42
- * Install java (we use java 17)
43
- * Download a molgenis-emx2-version-all.jar from [ releases] ( https://github.com/molgenis/molgenis-emx2/releases ) .
44
- * Download and install [ Postgresql] ( https://www.postgresql.org/download/ ) (we use 13)
45
- * Create postgresql database with name 'molgenis' and with superadmin user/pass 'molgenis'. On Linux/Mac commandline:
37
+ Prerequisites:
38
+ * Java version 21
39
+ * PostgreSQL version 15
40
+
41
+ Steps:
42
+ * Download a molgenis-emx2-version-all.jar file from [ releases] ( https://github.com/molgenis/molgenis-emx2/releases ) .
43
+ * Create a PostgreSQL database with name 'molgenis' and with superadmin username/password combination 'molgenis'.
46
44
``` console
47
45
sudo -u postgres psql
48
46
postgres=# create database molgenis;
49
47
postgres=# create user molgenis with superuser encrypted password 'molgenis';
50
48
postgres=# grant all privileges on database molgenis to molgenis;
51
49
```
52
- * Start molgenis-emx2; will run on 8080
53
- ```console
54
- java -jar molgenis-emx2-<version>-all.jar
55
- ```
50
+ * Start molgenis-emx2
51
+
52
+ `java -jar molgenis-emx2-<version>-all.jar`
56
53
57
- Optionally, you can change defaults using either java properties or using env variables:
54
+ The process will run on HTTP port 8080.
58
55
59
- * MOLGENIS_POSTGRES_URI
60
- * MOLGENIS_POSTGRES_USER
61
- * MOLGENIS_POSTGRES_PASS
62
- * MOLGENIS_HTTP_PORT
63
- * MOLGENIS_ADMIN_PW
56
+ Optionally, the following default values can be modified using either Java properties or using environment variables:
57
+ * `MOLGENIS_POSTGRES_URI`
58
+ * `MOLGENIS_POSTGRES_USER`
59
+ * `MOLGENIS_POSTGRES_PASS`
60
+ * `MOLGENIS_HTTP_PORT`
61
+ * `MOLGENIS_ADMIN_PW`
64
62
65
63
For example:
66
64
@@ -72,7 +70,7 @@ java -DMOLGENIS_POSTGRES_URI=jdbc:postgresql:mydatabase -DMOLGENIS_HTTP_PORT=909
72
70
73
71
If you have Kubernetes server then you can install using [ Helm] ( https://helm.sh/docs/ ) .
74
72
75
- Add helm chart repository (once)
73
+ Add Helm chart repository (once)
76
74
77
75
``` console
78
76
helm repo add emx2 https://github.com/molgenis/molgenis-ops-helm/tree/master/charts/molgenis-emx2
@@ -84,10 +82,10 @@ Run the latest release (see [Helm docs](https://helm.sh/docs/intro/using_helm/))
84
82
helm install emx2/emx2
85
83
```
86
84
87
- Update helm repository to get newest release
85
+ Refresh the Helm repository to get the latest release
88
86
89
87
``` console
90
88
helm repo update
91
89
```
92
90
93
- Alternatively, [ download latest helm chart ] ( https://github.com/mswertz/molgenis-emx2/tree/master/docs/helm-charts )
91
+ Alternatively, [ download the latest version of Helm Chart ] ( https://github.com/mswertz/molgenis-emx2/tree/master/docs/helm-charts )
0 commit comments