Skip to content

Commit

Permalink
Merge pull request #12 from SEKOIA-IO/update/doc
Browse files Browse the repository at this point in the history
update(doc): change SEKOIA.IO to Sekoia.io
  • Loading branch information
goudyj authored Jul 20, 2023
2 parents 74c2b79 + 2ed8539 commit fbfcce4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SEKOIA.IO Forwarder
# 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.
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.

To catch incoming events and apply the right intake key, this image processes each source on a specific TCP port.

Expand All @@ -20,7 +20,7 @@ The docker-compose folder contains the two files needed to start the container w
### intakes.yaml file
The `intakes.yaml` file is used to tell Rsyslog what ports and intake keys to use.
In the `intakes` key, specify:
* a name (it has nothing to do with SEKOIA.IO, it can be a random value)
* a name (it has nothing to do with Sekoia.io, it can be a random value)
* the protocol, tcp or udp
* a port, to process incoming events
* the intake key
Expand Down Expand Up @@ -57,7 +57,7 @@ logging:
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.
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.

```yaml
environment:
Expand Down

0 comments on commit fbfcce4

Please sign in to comment.