https://github.com/asapdotid/dcc-checkmk
Checkmk over Traefik
https://github.com/asapdotid/dcc-checkmk
checkmk monitoring-tool traefik
Last synced: 3 months ago
JSON representation
Checkmk over Traefik
- Host: GitHub
- URL: https://github.com/asapdotid/dcc-checkmk
- Owner: asapdotid
- License: mit
- Created: 2025-02-19T11:07:12.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T13:27:17.000Z (3 months ago)
- Last Synced: 2025-03-11T22:46:41.156Z (3 months ago)
- Topics: checkmk, monitoring-tool, traefik
- Language: Makefile
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Compose Checkmk + Traefik (Cloudflare)
This guide shows you how to deploy your containers behind Traefik reverse-proxy. It will obtain and refresh `HTTPS` certificates automatically and it comes with password-protected Traefik dashboard.
## Docker container
### Main container
- Docker Socket Proxy 1.26.2/latest
- Checkmk Raw 2.3.0-latest
- Traefik 3.2.x or 3.3.x
- Logger Alpine Linux 3.20
### Docker container:
- Docker Socket Proxy (security) - `Linuxserver.io` [Document](https://hub.docker.com/r/linuxserver/socket-proxy)
- Checkmk [Document](https://docs.checkmk.com/latest/en/)
- Traefik [Document](https://hub.docker.com/_/traefik)
- Logger (logrotate & cron) `Custom for Alpine`
### Step 1: Make Sure You Have Required Dependencies
- Git
- Docker
- Docker Compose
#### Example Installation on Debian-based Systems:
Official documentation for install Docker with new Docker Compose V2 [doc](https://docs.docker.com/engine/install/), and you can install too Docker Compose V1. Follow official documentation.
```bash
sudo apt-get install git docker-ce docker-ce-cli containerd.io docker-compose-plugin
```
### Step 2: Clone the Repository
```bash
git clone https://github.com/asapdotid/dcc-checkmk.git
cd dcc-checkmk
```
Make command help:
```bash
make help
```
### Step 3: Make Initial Environment Variables
```bash
make init
```
Modified file in `.make/.env` for build image
```ini
...
# Project variables
DOCKER_REGISTRY=docker.io
DOCKER_NAMESPACE=asapdotid
DOCKER_PROJECT_NAME=checkmk
# Docker image version
DOCKER_PROXY_VERSION=latest
TRAEFIK_VERSION=3.3
ALPINE_VERSION=3.20
CHECKMK_VERSION=2.3.0-latest
# Timezone for os and log level
TIMEZONE=Asia/Jakarta
```
### Step 3: Make Docker Compose Initial Environment Variables
```bash
make env
```
Modified file in `src/.env` for build image
### Step 4: Set Your Environments
Set both Checkmk and Traefik in `src/.env`
#### Checkmk envs
```ini
## CHECKMK ENVS
CHECKMK_USER_ID=1000
CHECKMK_GROUP_ID=1000
CHECKMK_SITE_ID=cmk
CHECKMK_ADMIN_PASSWORD=JYg0ZDYu23451
CHECKMK_DOMAIN_NAME=cmk.jogjascript.com
```
#### Traefik envs
The password is `adminpass` and you might want to change it before deploying to production.
Note: when used in docker-compose.yml all dollar signs in the hash need to be doubled for escaping.
> Install `Apache Tools` package to using `htpasswd`
> To create a `user`:`password` pair, the following command can be used:
```bash
echo $(htpasswd -nb user)
# OR
echo $(htpasswd -nb user password)
```
Running script:
```bash
echo $(htpasswd -nb admin)
New password:
Re-type new password:
admin:$apr1$W3jHMbEG$TCzyOICAWv/6kkraCHKYC0
```
or
```bash
echo $(htpasswd -nb admin adminpass)
admin:$apr1$W3jHMbEG$TCzyOICAWv/6kkraCHKYC0
```
The output has the following format: `username`:`password_hash`. The username doesn't have to be `admin`, feel free to change it (in the first line).
Encode password hash with `base64`:
```bash
echo '$apr1$W3jHMbEG$TCzyOICAWv/6kkraCHKYC0' | openssl enc -e -base64
JGFwcjEkVzNqSE1iRUckVEN6eU9JQ0FXdi82a2tyYUNIS1lDMAo=
```
Check decode:
```bash
echo 'JGFwcjEkVzNqSE1iRUckVEN6eU9JQ0FXdi82a2tyYUNIS1lDMAo=' | openssl enc -d -base64
```
You can paste the username into the `TRAEFIK_BASIC_AUTH_USERNAME` environment variable. The other part, `hashedPassword`, should be assigned to `TRAEFIK_BASIC_AUTH_PASSWORD_HASH`. Now you have your own `username`:`password` pair.
### Step 5: Launch Your Deployment
Optional create docker network `secure` & `proxy` for external used with other docker containers:
```bash
make env
make build
```
Docker composer make commands:
```bash
make up
# or
make down
```
### Step 6: Test Your Deployment
```bash
curl -I https://{domain_name}/
```
You can also test it in the browser:
- Checkmk dashboard: `https://cmk.{domain_name}/`
- Agent connection: `https://cmk.{domain_name}:9443`
- Traefik dashboard: `https://monitor.{domain_name}/`
## Deploying on a Public Server With Real Domain
Traefik requires you to define "Certificate Resolvers" in the static configuration, which are responsible for retrieving certificates from an ACME server.
Then, each "router" is configured to enable TLS, and is associated to a certificate resolver through the tls.certresolver configuration option.
Read [Traefik Let's Encrypt](https://doc.traefik.io/traefik/https/acme/)
Here is a list of supported providers, on this project:
- Cloudflare
Let's say you have a domain `example.com` and it's DNS records point to your production server. Just repeat the local deployment steps, but don't forget to update `TRAEFIK_DOMAIN_NAME`, `TRAEFIK_ACME_DNS_CHALLENGE_PROVIDER_EMAIL` & `TRAEFIK_ACME_DNS_CHALLENGE_PROVIDER_TOKEN` environment variables. In case of `example.com`, your `src/.env` file should have the following lines:
```ini
TRAEFIK_DOMAIN_NAME=example.com
[email protected]
TRAEFIK_ACME_DNS_CHALLENGE_PROVIDER_TOKEN=coudflare-access-token-123ABC
```
Setting correct email is important because it allows Let’s Encrypt to contact you in case there are any present and future issues with your certificates.
## License
MIT / BSD
## Author Information
This Docker Compose Checkmk + Traefik was created in 2025 by [Asapdotid](https://github.com/asapdotid) 🚀