diff --git a/README.md b/README.md index 953b891..c2970b1 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,9 @@ services: - /path/to/config:/config - /path/to/log:/var/log #optional ports: - - 514:5514 - - 601:6601 - - 6514:6514 + - 514:5514/udp + - 601:6601/tcp + - 6514:6514/tcp restart: unless-stopped ``` @@ -97,9 +97,9 @@ docker run -d \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Europe/London \ - -p 514:5514 \ - -p 601:6601 \ - -p 6514:6514 \ + -p 514:5514/udp \ + -p 601:6601/tcp \ + -p 6514:6514/tcp \ -v /path/to/config:/config \ -v /path/to/log:/var/log `#optional` \ --restart unless-stopped \ @@ -112,9 +112,9 @@ Container images are configured using parameters passed at runtime (such as thos | Parameter | Function | | :----: | --- | -| `-p 5514` | Syslog UDP | -| `-p 6601` | Syslog TCP | -| `-p 6514` | Syslog TLS | +| `-p 5514/udp` | Syslog UDP | +| `-p 6601/tcp` | Syslog TCP | +| `-p 6514/tcp` | Syslog TLS | | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | diff --git a/readme-vars.yml b/readme-vars.yml index e34379b..d06c3b1 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -31,9 +31,9 @@ opt_param_volumes: - { vol_path: "/var/log", vol_host_path: "/path/to/log", desc: "Stores logs collected by the syslog-ng service" } param_usage_include_ports: true param_ports: - - { external_port: "514", internal_port: "5514", port_desc: "Syslog UDP" } - - { external_port: "601", internal_port: "6601", port_desc: "Syslog TCP" } - - { external_port: "6514", internal_port: "6514", port_desc: "Syslog TLS" } + - { external_port: "514", internal_port: "5514/udp", port_desc: "Syslog UDP" } + - { external_port: "601", internal_port: "6601/tcp", port_desc: "Syslog TCP" } + - { external_port: "6514", internal_port: "6514/tcp", port_desc: "Syslog TLS" } # application setup block app_setup_block_enabled: true