Skip to content

Update README to clarify remote log information. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 25, 2022
Merged

Update README to clarify remote log information. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 51 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,22 @@ The architectures supported by this image are:

This container is designed to allow fail2ban to function at the host level, as well as at the docker container level.
If you are running applications on the host, you will need to set the `chain` to `INPUT` in the jail for that application.
All jails require the ability to read the application log files.
We recommend mounting each application's logs as a volume to the container (illustrated by the optional volumes in our documentation).

### Configuration Files
### [Configuration Files](https://github.com/linuxserver/fail2ban-confs)

On first run, the container will create a number of folders and files in `/config`. The default configurations for fail2ban are all disabled by default.

Please refer to the [Configuration README](https://github.com/linuxserver/fail2ban-confs/blob/master/README.md), which can be viewed in our repository, or in your config folder at `/config/fail2ban/README.md`.

### Remote Logs

All jails require the ability to read the application log files.
We recommend mounting each application's log folder as a volume to the container (illustrated by the optional volumes in our documentation).
Mounting individual log files can cause issues and is not recommended.

The `/remotelogs` path is designed to act as a parent for all log files you would like fail2ban to be able to use.
Each log file should be mounted in a subfolder underneath `/remotelogs`, ex:
- `/remotelogs/nginx/` would mount a folder containing the nginx logs to the container
- `/remotelogs/unificontroller/server.log` would mount a single file for the unifi controller logs to the container

## Usage

Expand All @@ -102,28 +103,23 @@ services:
volumes:
- /path/to/appdata/config:/config
- /var/log:/var/log:ro
- /path/to/airsonic/airsonic.log:/remotelogs/airsonic/airsonic.log:ro #optional
- /path/to/airsonic/log:/remotelogs/airsonic:ro #optional
- /path/to/apache2/log:/remotelogs/apache2:ro #optional
- /path/to/audit/audit.log:/remotelogs/audit/audit.log:ro #optional
- /path/to/authelia/authelia.log:/remotelogs/authelia/authelia.log:ro #optional
- /path/to/emby/embyserver.txt:/remotelogs/emby/embyserver.txt:ro #optional
- /path/to/exim/mainlog:/remotelogs/exim/mainlog:ro #optional
- /path/to/filebrowser/filebrowser.log:/remotelogs/filebrowser/filebrowser.log:ro #optional
- /path/to/gitea/gitea.log:/remotelogs/gitea/gitea.log:ro #optional
- /path/to/homeassistant/home-assistant.log:/remotelogs/homeassistant/home-assistant.log:ro #optional
- /path/to/lighttpd/error.log:/remotelogs/lighttpd/error.log:ro #optional
- /path/to/nextcloud/nextcloud.log:/remotelogs/nextcloud/nextcloud.log:ro #optional
- /path/to/authelia/log:/remotelogs/authelia:ro #optional
- /path/to/emby/log:/remotelogs/emby:ro #optional
- /path/to/filebrowser/log:/remotelogs/filebrowser:ro #optional
- /path/to/homeassistant/log:/remotelogs/homeassistant:ro #optional
- /path/to/lighttpd/log:/remotelogs/lighttpd:ro #optional
- /path/to/nextcloud/log:/remotelogs/nextcloud:ro #optional
- /path/to/nginx/log:/remotelogs/nginx:ro #optional
- /path/to/nzbget/nzbget.log:/remotelogs/nzbget/nzbget.log:ro #optional
- /path/to/overseerr/overseerr.log:/remotelogs/overseerr/overseerr.log:ro #optional
- /path/to/prowlarr/prowlarr.txt:/remotelogs/prowlarr/prowlarr.txt:ro #optional
- /path/to/radarr/radarr.txt:/remotelogs/radarr/radarr.txt:ro #optional
- /path/to/roundcube/errors:/remotelogs/roundcube/errors:ro #optional
- /path/to/sabnzbd/sabnzbd.log:/remotelogs/sabnzbd/sabnzbd.log:ro #optional
- /path/to/sonarr/sonarr.txt:/remotelogs/sonarr/sonarr.txt:ro #optional
- /path/to/unificontroller/server.log:/remotelogs/unificontroller/server.log:ro #optional
- /path/to/vaultwarden/vaultwarden.log:/remotelogs/vaultwarden/vaultwarden.log:ro #optional
- /path/to/vsftpd/vsftpd.log:/remotelogs/vsftpd/vsftpd.log:ro #optional
- /path/to/nzbget/log:/remotelogs/nzbget:ro #optional
- /path/to/overseerr/log:/remotelogs/overseerr:ro #optional
- /path/to/prowlarr/log:/remotelogs/prowlarr:ro #optional
- /path/to/radarr/log:/remotelogs/radarr:ro #optional
- /path/to/sabnzbd/log:/remotelogs/sabnzbd:ro #optional
- /path/to/sonarr/log:/remotelogs/sonarr:ro #optional
- /path/to/unificontroller/log:/remotelogs/unificontroller:ro #optional
- /path/to/vaultwarden/log:/remotelogs/vaultwarden:ro #optional
restart: unless-stopped
```

Expand All @@ -140,28 +136,23 @@ docker run -d \
-e TZ=America/New_York \
-v /path/to/appdata/config:/config \
-v /var/log:/var/log:ro \
-v /path/to/airsonic/airsonic.log:/remotelogs/airsonic/airsonic.log:ro `#optional` \
-v /path/to/airsonic/log:/remotelogs/airsonic:ro `#optional` \
-v /path/to/apache2/log:/remotelogs/apache2:ro `#optional` \
-v /path/to/audit/audit.log:/remotelogs/audit/audit.log:ro `#optional` \
-v /path/to/authelia/authelia.log:/remotelogs/authelia/authelia.log:ro `#optional` \
-v /path/to/emby/embyserver.txt:/remotelogs/emby/embyserver.txt:ro `#optional` \
-v /path/to/exim/mainlog:/remotelogs/exim/mainlog:ro `#optional` \
-v /path/to/filebrowser/filebrowser.log:/remotelogs/filebrowser/filebrowser.log:ro `#optional` \
-v /path/to/gitea/gitea.log:/remotelogs/gitea/gitea.log:ro `#optional` \
-v /path/to/homeassistant/home-assistant.log:/remotelogs/homeassistant/home-assistant.log:ro `#optional` \
-v /path/to/lighttpd/error.log:/remotelogs/lighttpd/error.log:ro `#optional` \
-v /path/to/nextcloud/nextcloud.log:/remotelogs/nextcloud/nextcloud.log:ro `#optional` \
-v /path/to/authelia/log:/remotelogs/authelia:ro `#optional` \
-v /path/to/emby/log:/remotelogs/emby:ro `#optional` \
-v /path/to/filebrowser/log:/remotelogs/filebrowser:ro `#optional` \
-v /path/to/homeassistant/log:/remotelogs/homeassistant:ro `#optional` \
-v /path/to/lighttpd/log:/remotelogs/lighttpd:ro `#optional` \
-v /path/to/nextcloud/log:/remotelogs/nextcloud:ro `#optional` \
-v /path/to/nginx/log:/remotelogs/nginx:ro `#optional` \
-v /path/to/nzbget/nzbget.log:/remotelogs/nzbget/nzbget.log:ro `#optional` \
-v /path/to/overseerr/overseerr.log:/remotelogs/overseerr/overseerr.log:ro `#optional` \
-v /path/to/prowlarr/prowlarr.txt:/remotelogs/prowlarr/prowlarr.txt:ro `#optional` \
-v /path/to/radarr/radarr.txt:/remotelogs/radarr/radarr.txt:ro `#optional` \
-v /path/to/roundcube/errors:/remotelogs/roundcube/errors:ro `#optional` \
-v /path/to/sabnzbd/sabnzbd.log:/remotelogs/sabnzbd/sabnzbd.log:ro `#optional` \
-v /path/to/sonarr/sonarr.txt:/remotelogs/sonarr/sonarr.txt:ro `#optional` \
-v /path/to/unificontroller/server.log:/remotelogs/unificontroller/server.log:ro `#optional` \
-v /path/to/vaultwarden/vaultwarden.log:/remotelogs/vaultwarden/vaultwarden.log:ro `#optional` \
-v /path/to/vsftpd/vsftpd.log:/remotelogs/vsftpd/vsftpd.log:ro `#optional` \
-v /path/to/nzbget/log:/remotelogs/nzbget:ro `#optional` \
-v /path/to/overseerr/log:/remotelogs/overseerr:ro `#optional` \
-v /path/to/prowlarr/log:/remotelogs/prowlarr:ro `#optional` \
-v /path/to/radarr/log:/remotelogs/radarr:ro `#optional` \
-v /path/to/sabnzbd/log:/remotelogs/sabnzbd:ro `#optional` \
-v /path/to/sonarr/log:/remotelogs/sonarr:ro `#optional` \
-v /path/to/unificontroller/log:/remotelogs/unificontroller:ro `#optional` \
-v /path/to/vaultwarden/log:/remotelogs/vaultwarden:ro `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/fail2ban:latest
```
Expand All @@ -178,28 +169,23 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e TZ=America/New_York` | Specify a timezone to use EG America/New_York |
| `-v /config` | Contains all relevant configuration files. |
| `-v /var/log:ro` | Host logs. Mounted as Read Only. |
| `-v /remotelogs/airsonic/airsonic.log:ro` | Optional path to airsonic log file. Mounted as Read Only. |
| `-v /remotelogs/airsonic:ro` | Optional path to airsonic log folder. Mounted as Read Only. |
| `-v /remotelogs/apache2:ro` | Optional path to apache2 log folder. Mounted as Read Only. |
| `-v /remotelogs/audit/audit.log:ro` | Optional path to auditd log file. Mounted as Read Only. |
| `-v /remotelogs/authelia/authelia.log:ro` | Optional path to authelia log file. Mounted as Read Only. |
| `-v /remotelogs/emby/embyserver.txt:ro` | Optional path to emby log file. Mounted as Read Only. |
| `-v /remotelogs/exim/mainlog:ro` | Optional path to exim log file. Mounted as Read Only. |
| `-v /remotelogs/filebrowser/filebrowser.log:ro` | Optional path to filebrowser log file. Mounted as Read Only. |
| `-v /remotelogs/gitea/gitea.log:ro` | Optional path to gitea log file. Mounted as Read Only. |
| `-v /remotelogs/homeassistant/home-assistant.log:ro` | Optional path to homeassistant log file. Mounted as Read Only. |
| `-v /remotelogs/lighttpd/error.log:ro` | Optional path to lighttpd error log file. Mounted as Read Only. |
| `-v /remotelogs/nextcloud/nextcloud.log:ro` | Optional path to nextcloud log file. Mounted as Read Only. |
| `-v /remotelogs/authelia:ro` | Optional path to authelia log folder. Mounted as Read Only. |
| `-v /remotelogs/emby:ro` | Optional path to emby log folder. Mounted as Read Only. |
| `-v /remotelogs/filebrowser:ro` | Optional path to filebrowser log folder. Mounted as Read Only. |
| `-v /remotelogs/homeassistant:ro` | Optional path to homeassistant log folder. Mounted as Read Only. |
| `-v /remotelogs/lighttpd:ro` | Optional path to lighttpd log folder. Mounted as Read Only. |
| `-v /remotelogs/nextcloud:ro` | Optional path to nextcloud log folder. Mounted as Read Only. |
| `-v /remotelogs/nginx:ro` | Optional path to nginx log folder. Mounted as Read Only. |
| `-v /remotelogs/nzbget/nzbget.log:ro` | Optional path to nzbget log file. Mounted as Read Only. |
| `-v /remotelogs/overseerr/overseerr.log:ro` | Optional path to overseerr log file. Mounted as Read Only. |
| `-v /remotelogs/prowlarr/prowlarr.txt:ro` | Optional path to prowlarr log file. Mounted as Read Only. |
| `-v /remotelogs/radarr/radarr.txt:ro` | Optional path to radarr log file. Mounted as Read Only. |
| `-v /remotelogs/roundcube/errors:ro` | Optional path to roundcube error log file. Mounted as Read Only. |
| `-v /remotelogs/sabnzbd/sabnzbd.log:ro` | Optional path to sabnzbd log file. Mounted as Read Only. |
| `-v /remotelogs/sonarr/sonarr.txt:ro` | Optional path to sonarr log file. Mounted as Read Only. |
| `-v /remotelogs/unificontroller/server.log:ro` | Optional path to unificontroller server log file. Mounted as Read Only. |
| `-v /remotelogs/vaultwarden/vaultwarden.log:ro` | Optional path to vaultwarden log file. Mounted as Read Only. |
| `-v /remotelogs/vsftpd/vsftpd.log:ro` | Optional path to vsftpd log file. Mounted as Read Only. |
| `-v /remotelogs/nzbget:ro` | Optional path to nzbget log folder. Mounted as Read Only. |
| `-v /remotelogs/overseerr:ro` | Optional path to overseerr log folder. Mounted as Read Only. |
| `-v /remotelogs/prowlarr:ro` | Optional path to prowlarr log folder. Mounted as Read Only. |
| `-v /remotelogs/radarr:ro` | Optional path to radarr log folder. Mounted as Read Only. |
| `-v /remotelogs/sabnzbd:ro` | Optional path to sabnzbd log folder. Mounted as Read Only. |
| `-v /remotelogs/sonarr:ro` | Optional path to sonarr log folder. Mounted as Read Only. |
| `-v /remotelogs/unificontroller:ro` | Optional path to unificontroller log folder. Mounted as Read Only. |
| `-v /remotelogs/vaultwarden:ro` | Optional path to vaultwarden log folder. Mounted as Read Only. |

### Portainer notice

Expand Down Expand Up @@ -314,4 +300,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64

## Versions

* **25.08.22:** - Update README to clarify remote log information.
* **09.08.22:** - Initial Release.
45 changes: 21 additions & 24 deletions readme-vars.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,50 +36,47 @@ cap_add_param_vars:
# optional parameters
opt_param_usage_include_vols: true
opt_param_volumes:
- { vol_path: "/remotelogs/airsonic/airsonic.log:ro", vol_host_path: "/path/to/airsonic/airsonic.log", desc: "Optional path to airsonic log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/airsonic:ro", vol_host_path: "/path/to/airsonic/log", desc: "Optional path to airsonic log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/apache2:ro", vol_host_path: "/path/to/apache2/log", desc: "Optional path to apache2 log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/audit/audit.log:ro", vol_host_path: "/path/to/audit/audit.log", desc: "Optional path to auditd log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/authelia/authelia.log:ro", vol_host_path: "/path/to/authelia/authelia.log", desc: "Optional path to authelia log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/emby/embyserver.txt:ro", vol_host_path: "/path/to/emby/embyserver.txt", desc: "Optional path to emby log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/exim/mainlog:ro", vol_host_path: "/path/to/exim/mainlog", desc: "Optional path to exim log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/filebrowser/filebrowser.log:ro", vol_host_path: "/path/to/filebrowser/filebrowser.log", desc: "Optional path to filebrowser log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/gitea/gitea.log:ro", vol_host_path: "/path/to/gitea/gitea.log", desc: "Optional path to gitea log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/homeassistant/home-assistant.log:ro", vol_host_path: "/path/to/homeassistant/home-assistant.log", desc: "Optional path to homeassistant log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/lighttpd/error.log:ro", vol_host_path: "/path/to/lighttpd/error.log", desc: "Optional path to lighttpd error log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/nextcloud/nextcloud.log:ro", vol_host_path: "/path/to/nextcloud/nextcloud.log", desc: "Optional path to nextcloud log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/authelia:ro", vol_host_path: "/path/to/authelia/log", desc: "Optional path to authelia log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/emby:ro", vol_host_path: "/path/to/emby/log", desc: "Optional path to emby log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/filebrowser:ro", vol_host_path: "/path/to/filebrowser/log", desc: "Optional path to filebrowser log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/homeassistant:ro", vol_host_path: "/path/to/homeassistant/log", desc: "Optional path to homeassistant log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/lighttpd:ro", vol_host_path: "/path/to/lighttpd/log", desc: "Optional path to lighttpd log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/nextcloud:ro", vol_host_path: "/path/to/nextcloud/log", desc: "Optional path to nextcloud log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/nginx:ro", vol_host_path: "/path/to/nginx/log", desc: "Optional path to nginx log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/nzbget/nzbget.log:ro", vol_host_path: "/path/to/nzbget/nzbget.log", desc: "Optional path to nzbget log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/overseerr/overseerr.log:ro", vol_host_path: "/path/to/overseerr/overseerr.log", desc: "Optional path to overseerr log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/prowlarr/prowlarr.txt:ro", vol_host_path: "/path/to/prowlarr/prowlarr.txt", desc: "Optional path to prowlarr log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/radarr/radarr.txt:ro", vol_host_path: "/path/to/radarr/radarr.txt", desc: "Optional path to radarr log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/roundcube/errors:ro", vol_host_path: "/path/to/roundcube/errors", desc: "Optional path to roundcube error log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/sabnzbd/sabnzbd.log:ro", vol_host_path: "/path/to/sabnzbd/sabnzbd.log", desc: "Optional path to sabnzbd log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/sonarr/sonarr.txt:ro", vol_host_path: "/path/to/sonarr/sonarr.txt", desc: "Optional path to sonarr log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/unificontroller/server.log:ro", vol_host_path: "/path/to/unificontroller/server.log", desc: "Optional path to unificontroller server log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/vaultwarden/vaultwarden.log:ro", vol_host_path: "/path/to/vaultwarden/vaultwarden.log", desc: "Optional path to vaultwarden log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/vsftpd/vsftpd.log:ro", vol_host_path: "/path/to/vsftpd/vsftpd.log", desc: "Optional path to vsftpd log file. Mounted as Read Only." }
- { vol_path: "/remotelogs/nzbget:ro", vol_host_path: "/path/to/nzbget/log", desc: "Optional path to nzbget log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/overseerr:ro", vol_host_path: "/path/to/overseerr/log", desc: "Optional path to overseerr log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/prowlarr:ro", vol_host_path: "/path/to/prowlarr/log", desc: "Optional path to prowlarr log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/radarr:ro", vol_host_path: "/path/to/radarr/log", desc: "Optional path to radarr log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/sabnzbd:ro", vol_host_path: "/path/to/sabnzbd/log", desc: "Optional path to sabnzbd log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/sonarr:ro", vol_host_path: "/path/to/sonarr/log", desc: "Optional path to sonarr log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/unificontroller:ro", vol_host_path: "/path/to/unificontroller/log", desc: "Optional path to unificontroller log folder. Mounted as Read Only." }
- { vol_path: "/remotelogs/vaultwarden:ro", vol_host_path: "/path/to/vaultwarden/log", desc: "Optional path to vaultwarden log folder. Mounted as Read Only." }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
This container is designed to allow fail2ban to function at the host level, as well as at the docker container level.
If you are running applications on the host, you will need to set the `chain` to `INPUT` in the jail for that application.
All jails require the ability to read the application log files.
We recommend mounting each application's logs as a volume to the container (illustrated by the optional volumes in our documentation).

### Configuration Files
### [Configuration Files](https://github.com/linuxserver/fail2ban-confs)

On first run, the container will create a number of folders and files in `/config`. The default configurations for fail2ban are all disabled by default.

Please refer to the [Configuration README](https://github.com/linuxserver/fail2ban-confs/blob/master/README.md), which can be viewed in our repository, or in your config folder at `/config/fail2ban/README.md`.

### Remote Logs

All jails require the ability to read the application log files.
We recommend mounting each application's log folder as a volume to the container (illustrated by the optional volumes in our documentation).
Mounting individual log files can cause issues and is not recommended.

The `/remotelogs` path is designed to act as a parent for all log files you would like fail2ban to be able to use.
Each log file should be mounted in a subfolder underneath `/remotelogs`, ex:
- `/remotelogs/nginx/` would mount a folder containing the nginx logs to the container
- `/remotelogs/unificontroller/server.log` would mount a single file for the unifi controller logs to the container

# changelog
changelogs:
- { date: "25.08.22:", desc: "Update README to clarify remote log information." }
- { date: "09.08.22:", desc: "Initial Release." }