From db4e2cf2664184603c69642db18baa07bb145222 Mon Sep 17 00:00:00 2001 From: florian Date: Tue, 14 Jun 2022 13:49:22 +0200 Subject: [PATCH] update linux docs, minor fix in ingress example and update default value for bunkernet job --- core/bunkernet/jobs/bunkernet-register.py | 4 ++-- docs/integrations.md | 26 +++++++++++------------ docs/troubleshooting.md | 7 +++++- examples/kubernetes-ingress/ingress.yml | 2 +- 4 files changed, 22 insertions(+), 17 deletions(-) diff --git a/core/bunkernet/jobs/bunkernet-register.py b/core/bunkernet/jobs/bunkernet-register.py index 2624de4..04dcb03 100755 --- a/core/bunkernet/jobs/bunkernet-register.py +++ b/core/bunkernet/jobs/bunkernet-register.py @@ -18,11 +18,11 @@ try : # Multisite case if os.getenv("MULTISITE") == "yes" : for first_server in os.getenv("SERVER_NAME").split(" ") : - if os.getenv(first_server + "_USE_BUNKERNET", os.getenv("USE_BUNKERNET")) == "yes" : + if os.getenv(first_server + "_USE_BUNKERNET", os.getenv("USE_BUNKERNET", "yes")) == "yes" : bunkernet_activated = True break # Singlesite case - elif os.getenv("USE_BUNKERNET") == "yes" : + elif os.getenv("USE_BUNKERNET", "yes") == "yes" : bunkernet_activated = True if not bunkernet_activated : logger.log("BUNKERNET", "ℹ️", "BunkerNet is not activated, skipping registration...") diff --git a/docs/integrations.md b/docs/integrations.md index eaaf6ee..8eb1d5d 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -683,7 +683,7 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt The first step is to add NGINX official repository : ```shell - sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring && \ + sudo apt install -y curl gnupg2 ca-certificates lsb-release debian-archive-keyring && \ curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null && \ echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ @@ -694,14 +694,14 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt You should now be able to install NGINX 1.20.2 : ```shell sudo apt update && \ - sudo apt install nginx=1.20.2-1~bullseye + sudo apt install -y nginx=1.20.2-1~bullseye ``` And finally install BunkerWeb 1.4.0 : ```shell curl -s https://packagecloud.io/install/repositories/bunkerity/bunkerweb/script.deb.sh | sudo bash && \ - apt update && \ - apt install -y bunkerweb=1.4.0 + sudo apt update && \ + sudo apt install -y bunkerweb=1.4.0 ``` To prevent upgrading NGINX and/or BunkerWeb packages when executing `apt upgrade`, you can use the following command : @@ -713,7 +713,7 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt The first step is to add NGINX official repository : ```shell - sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring && \ + sudo apt install -y curl gnupg2 ca-certificates lsb-release ubuntu-keyring && \ curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null && \ echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ @@ -724,14 +724,14 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt You should now be able to install NGINX 1.20.2 : ```shell sudo apt update && \ - sudo apt install nginx=1.20.2-1~jammy + sudo apt install -y nginx=1.20.2-1~jammy ``` And finally install BunkerWeb 1.4.0 : ```shell curl -s https://packagecloud.io/install/repositories/bunkerity/bunkerweb/script.deb.sh | sudo bash && \ - apt update && \ - apt install -y bunkerweb=1.4.0 + sudo apt update && \ + sudo apt install -y bunkerweb=1.4.0 ``` To prevent upgrading NGINX and/or BunkerWeb packages when executing `apt upgrade`, you can use the following command : @@ -743,13 +743,13 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt Fedora already provides NGINX 1.20.2 that we support : ```shell - sudo dnf install nginx-1.20.2 + sudo dnf install -y nginx-1.20.2 ``` ```shell curl -s https://packagecloud.io/install/repositories/bunkerity/bunkerweb/script.rpm.sh | sudo bash && \ - dnf check-update && \ - dnf install -y bunkerweb-1.4.0 + sudo dnf check-update && \ + sudo dnf install -y bunkerweb-1.4.0 ``` To prevent upgrading NGINX and/or BunkerWeb packages when executing `dnf upgrade`, you can use the following command : @@ -780,8 +780,8 @@ Repositories of Linux packages for BunkerWeb are available on [PackageCloud](htt ```shell dnf install -y epel-release && \ curl -s https://packagecloud.io/install/repositories/bunkerity/bunkerweb/script.rpm.sh | sudo bash && \ - dnf check-update && \ - dnf install -y bunkerweb-1.4.0 + sudo dnf check-update && \ + sudo dnf install -y bunkerweb-1.4.0 ``` To prevent upgrading NGINX and/or BunkerWeb packages when executing `dnf upgrade`, you can use the following command : diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 284c665..d61b27f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -75,7 +75,12 @@ Here is how you can access the logs depending on your integration : === "Linux" - The logs are located inside the `/var/log/nginx` directory. There is two files : + For errors related to BunkerWeb services (e.g. not starting), you can use `journalctl` : + ```shell + journalctl -u bunkerweb --no-pager + ``` + + Common logs are located inside the `/var/log/nginx` directory : ```shell cat /var/log/nginx/error.log cat /var/log/nginx/access.log diff --git a/examples/kubernetes-ingress/ingress.yml b/examples/kubernetes-ingress/ingress.yml index 4d67f20..a393311 100644 --- a/examples/kubernetes-ingress/ingress.yml +++ b/examples/kubernetes-ingress/ingress.yml @@ -5,7 +5,7 @@ metadata: annotations: bunkerweb.io/AUTOCONF: "yes" bunkerweb.io/AUTO_LETS_ENCRYPT: "yes" - bunkerweb.io/USE_LETS_ENCRYPT_STAGING: "yes" + spec: rules: - host: app1.example.com