mirrors/MeshCentral
2
0
Fork 0
mirror of https://github.com/Ylianst/MeshCentral.git synced 2025-10-26 11:27:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docker-docs): update readme

Browse Source
This commit is contained in:
Daan 2025-10-24 19:16:45 +02:00
parent bfe8ab3df3
commit 7662565695
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docker/README.md
View File

@ -6,7 +6,26 @@
> Then the container will overwrite it to a incorrect, but working state - perhaps non-working for your environment.
## Overview
This document provides a comprehensive guide to setting up and configuring MeshCentral in a Docker environment. It includes available options, security measures, and deployment instructions.
This document provides a comprehensive guide to setting up and configuring MeshCentral in a Docker environment.<br>
It includes available options, security measures, and deployment instructions.
MeshCentral provides a couple different Docker container variants:<br>
These variants are pulled through 3 main channels: `master` and `latest`.<br>
If you want to target versions, you can also target individual versions; such as `1.1.53`.
| Variant | Image tag | Full path |
|---------|-----------|-----------|
| All database backends | "" (empty) | ghcr.io/ylianst/meshcentral:\<version\> |
| No database backens (local only) | slim | ghcr.io/ylianst/meshcentral:\<version\>-slim |
| [MongoDB](https://www.mongodb.com/) backend included | mongodb | ghcr.io/ylianst/meshcentral:\<version\>-mongodb |
| [PostgreSQL](https://www.postgresql.org/) backend included | postgresql | ghcr.io/ylianst/meshcentral:\<version\>-postgresql |
| [Mysql](https://www.mysql.com/)/[MariaDB](https://mariadb.org/) backend(s) included | mysql | ghcr.io/ylianst/meshcentral:\<version\>-mysql |
So for a quick example: if you want to get the bleeding edge code with a PostgreSQL backend: `ghcr.io/ylianst/meshcentral:master-postgresql`<br>
So for another quick example: if you want to get a complete image at the latest released version: `ghcr.io/ylianst/meshcentral:latest`<br>
So for another quick example: if you want to get a released version with a MongoDB backend: `ghcr.io/ylianst/meshcentral:latest-mongodb`<br>
So for another quick example: if you want a very slim image with the latest code and only a local database: `ghcr.io/ylianst/meshcentral:master-slim`<br>
So as a last example: if you want to get a MariaDB/MySQL backend with MeshCentral version 1.1.53: `ghcr.io/ylianst/meshcentral:1.1.53-mysql`
## Environment Variables
Below is a breakdown of environment variables used in this setup.
@ -77,14 +96,14 @@ docker run -d \
-e MONGO_URL=mongodb://username:password@mongodb:27017/meshcentral \
-v meshcentral-data:/opt/meshcentral/meshcentral-data \
-p 443:443 \
ghcr.io/ylianst/meshcentral:<tag>
ghcr.io/ylianst/meshcentral:latest # or latest-mongodb
```
### Running with Docker Compose
```yaml
services:
meshcentral:
image: ghcr.io/ylianst/meshcentral:<tag>
image: ghcr.io/ylianst/meshcentral:latest
environment:
- HOSTNAME=myserver.domain.com
- ALLOW_NEW_ACCOUNTS=false
@ -96,6 +115,7 @@ services:
- meshcentral-web:/opt/meshcentral/meshcentral-web
- meshcentral-backups:/opt/meshcentral/meshcentral-backups
ports:
# You can add additional ports here in the same format. Such as for AMT or HTTP
- "443:443"
volumes:
meshcentral-data:
@ -158,7 +178,7 @@ PREINSTALL_LIBS=false
```
Then run Docker Compose:
```sh
docker-compose --env-file .env up -d
docker compose -f ./docker/compose.yaml --env-file .env up -d
```
# MeshCentral Docker Build Process