docker-documentation/docs/images/docker-syslog-ng.md

359 wiersze
14 KiB
Markdown
Czysty Zwykły widok Historia

2021-05-26 14:02:52 +00:00
---
title: syslog-ng
2025-01-30 18:56:58 +00:00
tags:
- Monitoring
description: "[syslog-ng](https://www.syslog-ng.com/products/open-source-log-management/) allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools."
2021-05-26 14:02:52 +00:00
---
2023-10-12 18:57:23 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-syslog-ng/blob/main/.github/CONTRIBUTING.md -->
2021-05-26 14:02:52 +00:00
# [linuxserver/syslog-ng](https://github.com/linuxserver/docker-syslog-ng)
2024-05-23 18:57:47 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsyslog-ng?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
2021-05-26 14:02:52 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-syslog-ng.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-syslog-ng)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-syslog-ng.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-syslog-ng/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-syslog-ng/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-syslog-ng/container_registry)
2021-10-08 06:41:12 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/syslog-ng)
2021-05-26 14:02:52 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syslog-ng.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/syslog-ng)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syslog-ng.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/syslog-ng)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-syslog-ng%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syslog-ng/job/main/)
2021-07-01 13:04:11 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fsyslog-ng%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/syslog-ng/latest/index.html)
2021-05-26 14:02:52 +00:00
[syslog-ng](https://www.syslog-ng.com/products/open-source-log-management/) allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools.
2023-10-12 18:57:23 +00:00
[![syslog-ng](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/syslog-ng-logo.png)](https://www.syslog-ng.com/products/open-source-log-management/)
2021-05-26 14:02:52 +00:00
## Supported Architectures
2023-11-16 18:54:54 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2021-05-26 14:02:52 +00:00
2022-05-06 06:46:13 +00:00
Simply pulling `lscr.io/linuxserver/syslog-ng:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2021-05-26 14:02:52 +00:00
The architectures supported by this image are:
2022-05-06 06:46:13 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-06-14 14:01:40 +00:00
| armhf | ❌ | |
2021-05-26 14:02:52 +00:00
## Application Setup
2024-01-31 18:54:40 +00:00
Edit `/config/syslog-ng.conf` to configure your logging sources and destinations.
2021-05-26 14:02:52 +00:00
2022-10-25 09:37:12 +00:00
The application pid, control file, etc. are all kept in /config so when using tools such as `syslog-ng-ctl` you need to specify the path e.g. `syslog-ng-ctl reload -c /config/syslog-ng.ctl`
2021-05-26 14:02:52 +00:00
More info at [syslog-ng](https://www.syslog-ng.com/technical-documents/list/syslog-ng-open-source-edition).
2024-09-26 18:57:54 +00:00
## Read-Only Operation
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
2025-01-01 22:43:57 +00:00
## Non-Root Operation
This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).
2021-05-26 14:02:52 +00:00
## Usage
2021-07-02 06:44:14 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2021-05-26 14:02:52 +00:00
2024-12-05 19:00:25 +00:00
!!! info
Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
2021-07-02 06:44:14 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2021-05-26 14:02:52 +00:00
```yaml
---
services:
syslog-ng:
2022-05-06 06:46:13 +00:00
image: lscr.io/linuxserver/syslog-ng:latest
2021-05-26 14:02:52 +00:00
container_name: syslog-ng
environment:
- PUID=1000
- PGID=1000
2023-02-17 06:37:48 +00:00
- TZ=Etc/UTC
2024-09-23 12:42:14 +00:00
- LOG_TO_STDOUT= #optional
2021-05-26 14:02:52 +00:00
volumes:
2024-01-31 18:54:40 +00:00
- /path/to/syslog-ng/config:/config
2021-05-26 14:02:52 +00:00
- /path/to/log:/var/log #optional
ports:
2021-07-14 20:04:45 +00:00
- 514:5514/udp
- 601:6601/tcp
- 6514:6514/tcp
2021-05-26 14:02:52 +00:00
restart: unless-stopped
```
2021-07-02 06:44:14 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2021-05-26 14:02:52 +00:00
```bash
docker run -d \
--name=syslog-ng \
-e PUID=1000 \
-e PGID=1000 \
2023-02-17 06:37:48 +00:00
-e TZ=Etc/UTC \
2024-09-23 12:42:14 +00:00
-e LOG_TO_STDOUT= `#optional` \
2021-07-14 20:04:45 +00:00
-p 514:5514/udp \
-p 601:6601/tcp \
-p 6514:6514/tcp \
2024-01-31 18:54:40 +00:00
-v /path/to/syslog-ng/config:/config \
2021-05-26 14:02:52 +00:00
-v /path/to/log:/var/log `#optional` \
--restart unless-stopped \
2022-05-06 06:46:13 +00:00
lscr.io/linuxserver/syslog-ng:latest
2021-05-26 14:02:52 +00:00
```
## Parameters
2023-10-12 18:57:23 +00:00
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2021-05-26 14:02:52 +00:00
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
2024-12-05 19:00:25 +00:00
| `514:5514/udp` | Syslog UDP |
| `601:6601/tcp` | Syslog TCP |
| `6514:6514/tcp` | Syslog TLS |
2021-05-26 14:02:52 +00:00
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-17 06:37:48 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2024-09-23 12:42:14 +00:00
| `LOG_TO_STDOUT=` | If set to `true` container will log to stdout, otherwise will log to `/config/log/`. |
2021-05-26 14:02:52 +00:00
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | Stores config and application files |
| `/var/log` | Stores logs collected by the syslog-ng service |
2021-10-08 06:41:12 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2024-12-05 19:00:25 +00:00
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
2025-01-01 22:43:57 +00:00
| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |
2021-10-08 06:41:12 +00:00
2021-05-26 14:02:52 +00:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```bash
2023-10-12 18:57:23 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2021-05-26 14:02:52 +00:00
```
2023-10-12 18:57:23 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2021-05-26 14:02:52 +00:00
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-12 18:57:23 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2021-05-26 14:02:52 +00:00
```bash
2023-10-12 18:57:23 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2021-05-26 14:02:52 +00:00
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=syslog-ng&query=%24.mods%5B%27syslog-ng%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=syslog-ng "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info
* Shell access whilst the container is running:
2023-10-12 18:57:23 +00:00
```bash
docker exec -it syslog-ng /bin/bash
```
2021-05-26 14:02:52 +00:00
* To monitor the logs of the container in realtime:
2023-10-12 18:57:23 +00:00
```bash
docker logs -f syslog-ng
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' syslog-ng
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syslog-ng:latest
```
## Updating Info
2024-01-11 18:59:57 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2023-10-12 18:57:23 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull syslog-ng
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d syslog-ng
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/syslog-ng:latest
```
* Stop the running container:
```bash
docker stop syslog-ng
```
* Delete the container:
```bash
docker rm syslog-ng
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
2024-09-26 18:57:54 +00:00
!!! tip
2023-10-12 18:57:23 +00:00
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-syslog-ng.git
cd docker-syslog-ng
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/syslog-ng:latest .
```
2024-11-14 18:58:56 +00:00
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
2023-10-12 18:57:23 +00:00
```bash
2024-11-14 18:58:56 +00:00
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
2023-10-12 18:57:23 +00:00
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2021-05-26 14:02:52 +00:00
2024-12-19 18:58:45 +00:00
To help with development, we generate this dependency graph.
??? info "Init dependency graph"
```d2
"syslog-ng:latest": {
docker-mods
base {
fix-attr +\nlegacy cont-init
}
docker-mods -> base
legacy-services
custom services
init-services -> legacy-services
init-services -> custom services
custom services -> legacy-services
legacy-services -> ci-service-check
init-migrations -> init-adduser
init-os-end -> init-config
init-config -> init-config-end
2025-01-01 22:43:57 +00:00
init-crontab-config -> init-config-end
2024-12-19 18:58:45 +00:00
init-syslog-ng-config -> init-config-end
2025-01-01 22:43:57 +00:00
init-config -> init-crontab-config
2024-12-19 18:58:45 +00:00
init-mods-end -> init-custom-files
base -> init-envfile
base -> init-migrations
init-config-end -> init-mods
init-mods-package-install -> init-mods-end
init-mods -> init-mods-package-install
init-adduser -> init-os-end
init-envfile -> init-os-end
init-custom-files -> init-services
init-config -> init-syslog-ng-config
init-services -> log-syslog-ng
init-services -> svc-cron
svc-cron -> legacy-services
init-services -> svc-syslog-ng
svc-syslog-ng -> legacy-services
}
Base Images: {
2025-01-01 22:43:57 +00:00
"baseimage-alpine:3.21"
2024-12-19 18:58:45 +00:00
}
"syslog-ng:latest" <- Base Images
```
2021-05-26 14:02:52 +00:00
## Versions
2025-01-01 22:43:57 +00:00
* **20.12.24:** - Rebase to Alpine 3.21.
2024-09-23 12:42:14 +00:00
* **24.09.24:** - Add opt to log to stdout.
2024-05-24 19:21:35 +00:00
* **24.05.24:** - Rebase to Alpine 3.20.
2024-01-31 18:54:40 +00:00
* **31.01.24:** - Rebase to Alpine 3.19.
2023-06-14 14:01:40 +00:00
* **11.06.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-01-11 14:31:34 +00:00
* **10.01.23:** - Add paho-mqtt-c library as required by the syslog-ng documentation
2022-12-30 22:35:34 +00:00
* **30.12.22:** - Rebase to Alpine 3.17, add libdbi-drivers for SQL support.
2022-10-03 22:22:55 +00:00
* **01.10.22:** - Rebase to Alpine 3.16, migrate to s6v3.
2021-12-18 19:22:07 +00:00
* **18.12.21:** - Rebase to Alpine 3.15.
2021-07-01 13:04:11 +00:00
* **01.07.21:** - Rebase to Alpine 3.14.
2021-05-26 14:02:52 +00:00
* **26.05.21:** - Initial release.