Skip to content

Commit

Permalink
Remove NGINX inside Add-on
Browse files Browse the repository at this point in the history
Remove NGINX in the add-on. Because now I prefer to use a reverse proxy
  • Loading branch information
casse-boubou committed May 25, 2024
1 parent 782c862 commit 3a96edd
Show file tree
Hide file tree
Showing 26 changed files with 49 additions and 350 deletions.
29 changes: 13 additions & 16 deletions sharry/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Example add-on configuration:
DefaultStore: database
domain: homeassistant.local
use_ssl: false
no_port_to_Base_URL: false
default_language: us
share_max_size_gb: 1.5
share_max_valid_days: 365
Expand Down Expand Up @@ -176,27 +177,23 @@ de l'option `use_ssl` et du port que vous avez indiqué pour `9090`.
Si le port n'est pas répertorié, l'add-on suppose que les utilisateurs
n'incluent pas de port dans l'URL lorsqu'ils accèdent à Sharry.

### Option: `ssl` (optional)
### Option: `use_ssl` (optional)

Active/Désactive SSL (HTTPS). Définissez-le sur `true` pour l'activer,
sinon `false`.
Défini le protocol 'http' par 'https' dans la base_url.
A utiliser si les utilisateurs utilisent SSL pour accéder à Sharry.
La valeur par défaut est `false -> (http)`.

**Note**: _Les paramètres SSL s'appliquent uniquement à l'accès direct
et n'ont aucun effet sur le service Ingress._
**Note**: _L'activation de l'accès SSL est hors de portée pour Sharry.
Cette option est pour les utilisateurs qui utilisent un proxy inverse
et y activent les certificats SSL._

### Option: `certfile` (optional)
### Option: `no_port_to_Base_URL` (optional)

Le fichier de certificat à utiliser pour SSL.
Enlève le port de l'add-on de la base_url.
La valeur par défaut est `false`.

**Note**: _Le fichier DOIT être stocké dans `/ssl/`,
qui est la valeur par défaut_

### Option: `keyfile` (optional)

Le fichier de clé privée à utiliser pour SSL.

**Note**: _Le fichier DOIT être stocké dans `/ssl/`,
qui est la valeur par défaut_
**Note**: _Probablement necessaire si vous utilisez un proxy inverse
et que l'URL d'accès a Sharry est du type `http(s)://domain.org`_

### Option: `access.add_port` (optional)

Expand Down
12 changes: 0 additions & 12 deletions sharry/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,6 @@ RUN apk add --no-cache \
mariadb-server-utils=10.11.8-r0 \
pwgen=2.08-r3

# add Nginx
# hadolint ignore=DL3009
RUN \
apk add --no-cache \
nginx=1.26.0-r1 \
&& rm -fr \
/etc/nginx \
/tmp/* \
\
&& mkdir -p /var/log/nginx \
&& touch /var/log/nginx/error.log

ENV \
LD_PRELOAD="/usr/local/lib/libjemalloc.so.2" \
S6_SERVICES_GRACETIME=18000
Expand Down
15 changes: 6 additions & 9 deletions sharry/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,23 @@ codenotary: [email protected]
init: false
map:
- share:rw
- ssl
services:
- mysql:provide
auth_api: true
webui: "[PROTO:ssl]://[HOST]:[PORT:9090]"
webui: http://[HOST]:[PORT:9090]
ports:
9090/tcp: 9090
3306/tcp: null
ports_description:
9090/tcp: Sharry Web interface
9090/tcp: HTTP listen port
3306/tcp: Mariadb port
backup_post: unlock-tables-for-backup
backup_pre: lock-tables-for-backup
options:
conf_overrides: []
domain: homeassistant.local
ssl: false
certfile: fullchain.pem
keyfile: privkey.pem
use_ssl: false
no_port_to_Base_URL: false
default_language: us
share_max_size_gb: 1.5
share_max_valid_days: 365
Expand Down Expand Up @@ -59,9 +57,8 @@ schema:
copy_db_source: list(database|filesystem)?
copy_db_target: list(database|filesystem)?
domain: match([^\/:]+)
ssl: bool?
certfile: str?
keyfile: str?
use_ssl: bool?
no_port_to_Base_URL: bool?
default_language: match([A-Za-z]{2})?
share_max_size_gb: float(0.01,)?
share_max_valid_days: int(1,)?
Expand Down
18 changes: 14 additions & 4 deletions sharry/rootfs/etc/cont-init.d/30-config.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,33 @@ for var in $(bashio::config 'conf_overrides|keys'); do
bashio::exit.nok

# Prevent break of Nginx reverse proxy
elif [[ ${property} =~ ^sharry[.]restserver[.]bind ]]; then
elif [[ ${property} =~ ^sharry[.]restserver[.]bind[.]address ]]; then
bashio::log.fatal
bashio::log.fatal "Your config attempts to override settings in the bind module."
bashio::log.fatal "This is not allowed as it could break the addon."
bashio::log.fatal "If you use NGINX this is not allowed as it could break the addon."
bashio::log.fatal
bashio::log.fatal "Remove any conf_overrides you have added with a property"
bashio::log.fatal "matching this pattern and try again:"
bashio::log.fatal "'sharry.restserver.bind.*'"
bashio::log.fatal "'sharry.restserver.bind.address'"
bashio::log.fatal
bashio::exit.nok
elif [[ ${property} =~ ^sharry[.]restserver[.]bind[.]port ]]; then
bashio::log.fatal
bashio::log.fatal "Your config attempts to override settings in the bind module."
bashio::log.fatal "If you use NGINX this is not allowed as it could break the addon."
bashio::log.fatal "USE AT YOUR OWN RISK !!!!"
bashio::log.fatal
bashio::log.fatal "Please remove any conf_overrides you have added with a property"
bashio::log.fatal "matching this pattern and try again:"
bashio::log.fatal "'sharry.restserver.bind.port'"
bashio::log.fatal

# Warning when changing chunk-size because of Nginx client_max_body_size parameter
elif [[ ${property} =~ ^sharry[.]restserver[.]webapp[.]chunk-size ]]; then
bashio::log.fatal
bashio::log.fatal "WARNING"
bashio::log.fatal "Your config attempts to override settings in the CHUNK-SIZE value."
bashio::log.fatal "Do NOT exceed the value of 100M."
bashio::log.fatal "If you use NGINX do NOT exceed the value of 100M."
bashio::log.fatal "This is not allowed as it could break the addon."
bashio::log.fatal
bashio::log.fatal
Expand Down
96 changes: 0 additions & 96 deletions sharry/rootfs/etc/nginx/includes/mime.types

This file was deleted.

15 changes: 0 additions & 15 deletions sharry/rootfs/etc/nginx/includes/proxy_params.conf

This file was deleted.

6 changes: 0 additions & 6 deletions sharry/rootfs/etc/nginx/includes/server_params.conf

This file was deleted.

8 changes: 0 additions & 8 deletions sharry/rootfs/etc/nginx/includes/ssl_params.conf

This file was deleted.

7 changes: 0 additions & 7 deletions sharry/rootfs/etc/nginx/includes/upstream.conf

This file was deleted.

47 changes: 0 additions & 47 deletions sharry/rootfs/etc/nginx/nginx.conf

This file was deleted.

25 changes: 0 additions & 25 deletions sharry/rootfs/etc/nginx/servers/direct-ssl.disabled

This file was deleted.

21 changes: 0 additions & 21 deletions sharry/rootfs/etc/nginx/servers/direct.disabled

This file was deleted.

Empty file.
Loading

0 comments on commit 3a96edd

Please sign in to comment.