add docker build docs
Simon Smith committed
Aug 2, 2022 at 13:39 UTC
22351762b42058f5e09cda86934362327bd9ca0d
2 files changed
+32
-33
docker/BUILD.md
new
+29
@@ -0,0 +1,29 @@
1
+# How to create a docker image for meshcentral
2
+
3
+```
4
+> git clone https://github.com/Ylianst/MeshCentral.git
5
+> cd MeshCentral
6
+
7
+> docker build -f docker/Dockerfile --force-rm -t meshcentral .
8
+
9
+# alternative, if you want to include the mongodb-tools (mongodump, ...), you can add the 'INCLUDE_MONGODBTOOLS=yes' build argument
10
+> docker build -f docker/Dockerfile --force-rm --build-arg INCLUDE_MONGODBTOOLS=yes -t meshcentral .
11
+
12
+# (optional) cleanup after docker build:
13
+> cd ..
14
+> rm -rf MeshCentral/
15
+```
16
+
17
+> | Argument | Description |
18
+> | :--- | :--- |
19
+> | -f docker/Dockerfile | Path/Name of the Dockerfile |
20
+> | --force-rm | Always remove intermediate containers |
21
+> | -t meshcentral | Name and optionally a tag in the 'name:tag' format |
22
+
23
+### Optional build arguments
24
+> | Argument | Description |
25
+> | :--- | :--- |
26
+> | INCLUDE_MONGODBTOOLS=yes | Includes mongodb-tools (mongodump, ...) in the image |
27
+> | DISABLE_MINIFY=yes | Disables the minification of files |
28
+> | DISABLE_TRANSLATE=yes | Disables the translation of files |
29
+
docker/readme.md
+3
-33
@@ -1,33 +1,3 @@
1
-
2
-# How to create a docker image for meshcentral
3
-
4
-```
5
-> git clone https://github.com/Ylianst/MeshCentral.git
6
-> cd MeshCentral
7
-
8
-> docker build -f docker/Dockerfile --force-rm -t meshcentral .
9
-
10
-# alternative, if you want to include the mongodb-tools (mongodump, ...), you can add the 'INCLUDE_MONGODBTOOLS=yes' build argument
11
-> docker build -f docker/Dockerfile --force-rm --build-arg INCLUDE_MONGODBTOOLS=yes -t meshcentral .
12
-
13
-# (optional) cleanup after docker build:
14
-> cd ..
15
-> rm -rf MeshCentral/
16
-```
17
-
18
-> | Argument | Description |
19
-> | :--- | :--- |
20
-> | -f docker/Dockerfile | Path/Name of the Dockerfile |
21
-> | --force-rm | Always remove intermediate containers |
22
-> | -t meshcentral | Name and optionally a tag in the 'name:tag' format |
23
-
24
-### Optional build arguments
25
-> | Argument | Description |
26
-> | :--- | :--- |
27
-> | INCLUDE_MONGODBTOOLS=yes | Includes mongodb-tools (mongodump, ...) in the image |
28
-> | DISABLE_MINIFY=yes | Disables the minification of files |
29
-> | DISABLE_TRANSLATE=yes | Disables the translation of files |
30
-
1
# Create folder-structure and files
2
3
```
@@ -62,7 +32,7 @@ REVERSE_PROXY_TLS_PORT=
32
IFRAME=false
33
# set to false if you want disable self-service creation of new accounts besides the first (admin)
34
ALLOW_NEW_ACCOUNTS=true
65
-# set to true to enable WebRTC - per documentation it is not officially released with meshcentral, but is solid enough to work with. Use with caution
35
+# set to true to enable WebRTC - per documentation it is not officially released with meshcentral and currently experimental. Use with caution
36
WEBRTC=false
37
# set to true to allow plugins
38
ALLOWPLUGINS=false
@@ -80,7 +50,7 @@ services:
50
meshcentral:
51
restart: always
52
container_name: meshcentral
83
- image: meshcentral
53
+ image: ghcr.io/ylianst/meshcentral:latest
54
ports:
55
# MeshCentral will moan and try everything not to use port 80, but you can also use it if you so desire, just change the config.json according to your needs
56
- 8086:443
@@ -121,7 +91,7 @@ services:
91
meshcentral:
92
restart: always
93
container_name: meshcentral
124
- image: meshcentral
94
+ image: ghcr.io/ylianst/meshcentral:latest
95
depends_on:
96
- mongodb
97
ports: