From 6f078e5b33889164e46203b7f10f33cecdd07825 Mon Sep 17 00:00:00 2001 From: Jean GOUDY Date: Thu, 20 Jul 2023 14:24:35 +0200 Subject: [PATCH] update(doc): change the name and add tag latest --- .github/workflows/build-docker-image.yaml | 3 ++- README.md | 7 +++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-docker-image.yaml b/.github/workflows/build-docker-image.yaml index e44937d..4932dee 100644 --- a/.github/workflows/build-docker-image.yaml +++ b/.github/workflows/build-docker-image.yaml @@ -31,4 +31,5 @@ jobs: with: push: true tags: | - ghcr.io/sekoia-io/sekoiaio-docker-concentrator:1.0 \ No newline at end of file + ghcr.io/sekoia-io/sekoiaio-docker-concentrator:1.0 + ghcr.io/sekoia-io/sekoiaio-docker-concentrator:latest \ No newline at end of file diff --git a/README.md b/README.md index da624ff..f568680 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# SEKOIA.IO Docker concentrator - BETA -**Important**: This project is currently in BETA +# SEKOIA.IO Forwarder The files in this repository are used to build and create a Docker container running a Rsyslog as a concentrator to forward events to SEKOIA.IO. @@ -35,7 +34,7 @@ intakes: port: 20516 intake_key: INTAKE_KEY_FOR_TECHNO_1 - name: Techno2 - protocol: udp + protocol: tcp port: 20517 intake_key: INTAKE_KEY_FOR_TECHNO_2 - name: Techno3 @@ -55,7 +54,7 @@ logging: max-size: "1000m" max-file: "2" ``` -Docker logging system give you the flexibility to view events received on the container in real time with the command `docker logs `. These logs are stored by default in `/var/lib/docker/containers//-json.log`. To avoid the overload of disk space, some options are specified. `max-size` specifies the max size a one file and `max-file` specifies the total number of files allowed. When the maximum number of files is reached, a log rotation is performed and the oldest file is deleted. +Docker logging system enables you to view events received on the container in real time with the command `docker logs `. These logs are stored by default in `/var/lib/docker/containers//-json.log`. To avoid the overload of disk space, some options are specified. `max-size` specifies the max size a one file and `max-file` specifies the total number of files allowed. When the maximum number of files is reached, a log rotation is performed and the oldest file is deleted. #### Environment variables This image uses two environment variables to customize the container. These variables are used to define a queue for incoming logs in case there is an temporaly issue in transmitting events to SEKOIA.IO. The queue stores messages in memory up to a certain number of events and then store them on disk.