diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d8f22fb..964bc6e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,8 +12,10 @@ - Add EXTERNAL_PLUGIN_URLS setting to automatically download and install external plugins - Add log_default() plugin hook - Add various certbot-dns examples -- Force NGINX version dependencies in Linux packages DEB/RPM +- Add mattermost example +- Add radarr example - Add Discord and Slack to list of official plugins +- Force NGINX version dependencies in Linux packages DEB/RPM ## v1.4.1 - 2022/16/06 diff --git a/examples/mattermost/README.md b/examples/mattermost/README.md new file mode 100644 index 00000000..19ca6d4c --- /dev/null +++ b/examples/mattermost/README.md @@ -0,0 +1,7 @@ +We assume that you are already familiar with Mattermost Docker stack. You will find more info [in the documentation](https://docs.mattermost.com/install/install-docker.html) and the [mattermost/docker repo](https://github.com/mattermost/docker). + +Procedure : +- Edit domains in the compose file +- Edit variables in the .env file +- Run setup.sh as root +- Start services with `docker-compose up -d` diff --git a/examples/mattermost/docker-compose.yml b/examples/mattermost/docker-compose.yml index dd42ae70..86c2525b 100644 --- a/examples/mattermost/docker-compose.yml +++ b/examples/mattermost/docker-compose.yml @@ -3,7 +3,7 @@ version: '3' services: mybunker: - image: bw + image: bunkerity/bunkerweb:1.4.2 ports: - 80:8080 - 443:8443 @@ -22,13 +22,29 @@ services: - USE_CLIENT_CACHE=yes - SERVE_FILES=no - MAX_CLIENT_SIZE=50m - - ALLOWED_METHODS=GET|POST|HEAD|DELETE|PUT - USE_GZIP=yes + # Methods used to query the api + # more info at https://api.mattermost.com/ + - ALLOWED_METHODS=GET|POST|HEAD|DELETE|PUT + # Reverse proxy to Mattermost + # second endpoint needs websocket enabled + # more info at https://docs.mattermost.com/install/config-proxy-nginx.html - USE_REVERSE_PROXY=yes + - REVERSE_PROXY_INTERCEPT_ERRORS=no - REVERSE_PROXY_URL_1=/ - REVERSE_PROXY_HOST_1=http://mattermost:8065 - REVERSE_PROXY_URL_2=~ /api/v[0-9]+/(users/)?websocket$$ + - REVERSE_PROXY_HOST_2=http://mattermost:8065 - REVERSE_PROXY_WS_2=yes + # Default limit rate for URLs + - LIMIT_REQ_URL_1=/ + - LIMIT_REQ_RATE_1=3r/s + # Limit rate for api endpoints + - LIMIT_REQ_URL_2=^/api/ + - LIMIT_REQ_RATE_2=10r/s + # Limit rate for static resources + - LIMIT_REQ_URL_3=^/static/ + - LIMIT_REQ_RATE_3=10r/s mattermost: depends_on: diff --git a/examples/radarr/README.md b/examples/radarr/README.md new file mode 100644 index 00000000..051783c1 --- /dev/null +++ b/examples/radarr/README.md @@ -0,0 +1 @@ +Tested with Firefox. This is not working with Chrome, any PR will be appreciated :). diff --git a/examples/radarr/docker-compose.yml b/examples/radarr/docker-compose.yml new file mode 100644 index 00000000..d311ad3f --- /dev/null +++ b/examples/radarr/docker-compose.yml @@ -0,0 +1,52 @@ +version: '3.5' + +services: + + mybunker: + image: bunkerity/bunkerweb:1.4.2 + ports: + - 80:8080 + - 443:8443 + # ⚠️ read this if you use local folders for volumes ⚠️ + # bunkerweb runs as an unprivileged user with UID/GID 101 + # don't forget to edit the permissions of the files and folders accordingly + # example if you need to create a directory : mkdir folder && chown root:101 folder && chmod 770 folder + # another example for existing folder : chown -R root:101 folder && chmod -R 770 folder + # more info at https://docs.bunkerweb.io + volumes: + - bw_data:/data + environment: + - SERVER_NAME=www.example.com # replace with your domain + - AUTO_LETS_ENCRYPT=yes + - DISABLE_DEFAULT_SERVER=yes + - USE_CLIENT_CACHE=yes + - SERVE_FILES=no + - MAX_CLIENT_SIZE=50m + - USE_GZIP=yes + # Methods used by the radarr API + # more info at https://radarr.video/docs/api/ + - ALLOWED_METHODS=GET|POST|HEAD|DELETE|PUT + # Proxy requests to radarr + # websocket is needed + - USE_REVERSE_PROXY=yes + - REVERSE_PROXY_URL=/ + - REVERSE_PROXY_HOST=http://radarr:7878 + - REVERSE_PROXY_WS=yes + # Increase request rate for API endpoints + - LIMIT_REQ_URL_1=^/api/ + - LIMIT_REQ_RATE_1=10r/s + + radarr: + image: lscr.io/linuxserver/radarr:latest + container_name: radarr + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/London + volumes: + - ./config:/config + - ./movies:/movies #optional + - ./downloads:/downloads #optional + +volumes: + bw_data: