Skip to content

Commit

Permalink
Merge pull request #11 from SEKOIA-IO/update/doc
Browse files Browse the repository at this point in the history
update(doc): change the name and add tag latest
  • Loading branch information
goudyj authored Jul 20, 2023
2 parents 96fc49d + 6f078e5 commit 74c2b79
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/build-docker-image.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ jobs:
with:
push: true
tags: |
ghcr.io/sekoia-io/sekoiaio-docker-concentrator:1.0
ghcr.io/sekoia-io/sekoiaio-docker-concentrator:1.0
ghcr.io/sekoia-io/sekoiaio-docker-concentrator:latest
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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 <container_name>`. These logs are stored by default in `/var/lib/docker/containers/<container_uuid>/<container_uuid>-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 <container_name>`. These logs are stored by default in `/var/lib/docker/containers/<container_uuid>/<container_uuid>-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.
Expand Down

0 comments on commit 74c2b79

Please sign in to comment.