doc: move badges

.gitea/workflows/cd.yaml

@@ -0,0 +1,26 @@
+name: Continuous Delivery
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  build_n_upload:
+    runs-on: linux
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-tags: true
+      - name: Build tarball
+        run: make tarball
+        env:
+          GIT_REFERENCE: ${{ github.ref }}
+      - name: Build rpm package
+        run: rpmbuild -ba "$(make name).spec"
+      - name: Upload rpm package
+        run: make upload
+        env:
+          GIT_PACKAGES_USERNAME: ${{ vars.GIT_PACKAGES_USERNAME }}
+          GIT_PACKAGES_TOKEN: ${{ secrets.GIT_PACKAGES_TOKEN }}

.gitea/workflows/ci.yaml

@@ -6,8 +6,17 @@ on:
       - main
 
 jobs:
-  env:
+  lint_n_build:
     runs-on: linux
     steps:
-      - name: Show env
+      - name: Git checkout
-        run: env | sort
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Lint shell scripts
+        run: shellcheck files/sbin/certbot_renew
+      - name: Build tarball
+        run: make tarball
+      - name: Build rpm file
+        run: rpmbuild -ba netoik-rp.spec

.gitignore

@@ -1,2 +1,3 @@
 *.swp
 *.env
+/.idea

Makefile

@@ -1,12 +1,16 @@
-NAME = $(shell basename $(PWD))
+NAME = netoik-rp
-VERSION = $(shell git describe | sed 's/-/./g')
+VERSION = $(shell git describe --abbrev=0)
-BRANCH = $(shell git branch --show-current)
+RELEASE = $(shell git rev-parse --short HEAD)
+REFERENCE = $(if $(GIT_REFERENCE),$(GIT_REFERENCE),$(shell git branch --show-current))
+BUILD_ARCH = noarch
 
+RPM_RPMDIR = $(shell rpm --eval '%{_rpmdir}')
 RPM_SBINDIR = $(shell rpm --eval '%{_sbindir}')
 RPM_SOURCEDIR = $(shell rpm --eval '%{_sourcedir}')
 RPM_SYSCONFDIR = $(shell rpm --eval '%{_sysconfdir}')
 RPM_UNITDIR = $(shell rpm --eval '%{_unitdir}')
 RPM_TARBALL_PATH = $(RPM_SOURCEDIR)/$(NAME)-$(VERSION).tar.gz
+RPM_BUILD_PATH = $(RPM_RPMDIR)/$(BUILD_ARCH)/$(NAME)-$(VERSION)-$(RELEASE).$(BUILD_ARCH).rpm
 
 .PHONY: name
 name:
@@ -16,15 +20,13 @@ name:
 version:
 	@echo "$(VERSION)"
 
-$(RPM_TARBALL_PATH): *
+.PHONY: release
-	git archive --format=tar.gz \
+release:
-	            --output="$@" \
+	@echo "$(RELEASE)"
-	            --prefix="$(NAME)-$(VERSION)/" \
-	            --verbose \
-	            "$(BRANCH)"
 
-.PHONY: tarball
+.PHONY: build_arch
-tarball: $(RPM_TARBALL_PATH)
+build_arch:
+	@echo "$(BUILD_ARCH)"
 
 .PHONY: install
 install:
@@ -33,3 +35,17 @@ install:
 	install --mode=600 --target-directory=$(DESTDIR)$(RPM_SYSCONFDIR)/certbot files/certbot/ovh.ini
 	install --mode=644 --target-directory=$(DESTDIR)$(RPM_UNITDIR) files/systemd/certbot-renew.service files/systemd/certbot-renew.timer
 	install --mode=755 --target-directory=$(DESTDIR)$(RPM_SBINDIR) files/sbin/certbot_renew
+
+$(RPM_TARBALL_PATH): *
+	git archive --format=tar.gz \
+	            --output="$@" \
+	            --prefix="$(NAME)-$(VERSION)/" \
+	            --verbose \
+	            "$(REFERENCE)"
+
+.PHONY: tarball
+tarball: $(RPM_TARBALL_PATH)
+
+.PHONY: upload
+upload:
+	curl --fail-with-body --upload-file "$(RPM_BUILD_PATH)" --user "$(GIT_PACKAGES_USERNAME):$(GIT_PACKAGES_TOKEN)" https://git.netoik.io/api/packages/samuel/rpm/upload

README.md

@@ -1,3 +1,86 @@
-# netoik-rp
+# Netoïk reverse proxy ![badge](https://git.netoik.io/samuel/netoik-rp/actions/workflows/ci.yaml/badge.svg) ![badge](https://git.netoik.io/samuel/netoik-rp/actions/workflows/cd.yaml/badge.svg)
 
-Netoïk reverse proxy
+Build an RPM package which will install several tools.
+
+- `Nginx` with:
+    - ssl settings
+    - security headers
+    - default site configuration
+
+
+- `Certbot` certificates with:
+    - ovh configuration to renew certs
+    - a command tool certbot_renew
+    - a systemctl certbot renew timer
+
+
+# Development
+
+A `Makefile` is integrated to let you run some basic commands.
+
+- To display some information about the project
+  ```shell
+  make name
+  make version
+  make release
+  make build_arch
+  ```
+
+- To build a tarball:
+  ```shell
+  make tarball 
+  ```
+  
+- To build a rpm package:
+  ```shell
+  rpmbuild -ba netoik-rp.spec
+  ```
+  
+- To upload rpm package to Gitea repository:
+  ```shell
+  # This command needs 2 env variables:
+  # GIT_PACKAGES_USERNAME and GIT_PACKAGES_TOKEN
+  make upload
+  ```
+
+
+# CI / CD
+
+Two workflows are set up.
+
+- Continuous Integration:
+  - triggered by each push on branch `main`
+  - runs shellcheck on script `certbot_renew`
+  - builds tarball and rpm package to test everything is OK
+
+
+- Continuous Delivery:
+  - triggered by each tag pushed
+  - builds tarball
+  - builds and uploads rpm package to `Gitea` repository
+
+
+# Deployment
+
+Security Notes:
+  - no Continuous Deployment set for security reasons **(1)**
+  - no GPG signing for security reasons **(1)**
+
+**(1)** Act runner does not have sudo access, which prevents 
+from deploying via `dnf` and signing via `gpg`
+
+Some commands to deploy the RPM package on server:
+  ```shell
+  # Add Gitea repo to your repolist
+  dnf config-manager --add-repo https://git.netoik.io/api/packages/samuel/rpm.repo
+  
+  # Check Gitea repo is added
+  dnf repolist | grep gitea-samuel
+  
+  # Show available package releases
+  dnf --showduplicates netoik-rp
+  
+  # Install or upgrade package
+  dnf --nogpgcheck install netoik-rp
+  dnf --nogpgcheck upgrade netoik-rp 
+  ```

files/nginx/0_security.conf

@@ -14,12 +14,15 @@ resolver                     127.0.0.1;
 
 # Add some basic security headers from OWASP
 # see: https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Headers_Cheat_Sheet.html
+# And Nextcloud doc
+# see: https://docs.nextcloud.com/server/31/admin_manual/installation/harden_server.html
 add_header                   Strict-Transport-Security            "max-age=63072000; includeSubDomains; preload;"                                      always;
-add_header                   X-Frame-Options                "DENY"                                                               always;
+add_header                   X-Frame-Options                      "sameorigin"                                                                         always;
-add_header                   X-XSS-Protection               "0"                                                                  always;
+add_header                   X-XSS-Protection                     "1;mode=block"                                                                       always;
 add_header                   X-Content-Type-Options               "nosniff"                                                                            always;
+add_header                   X-Permitted-Cross-Domain-Policies    "none"                                                                               always;
 add_header                   Referrer-Policy                      "strict-origin-when-cross-origin"                                                    always;
-add_header                   Content-Security-Policy        "default-src 'self'; frame-ancestors 'self'; form-action 'self';"    always;
+add_header                   Content-Security-Policy              "default-src 'self' 'unsafe-inline'; frame-ancestors 'self'; form-action 'self';"    always;
 add_header                   Cross-Origin-Opener-Policy           "same-origin"                                                                        always;
 add_header                   Cross-Origin-Resource-Policy         "same-site"                                                                          always;
 add_header                   Permissions-Policy                   "geolocation=(), camera=(), microphone=()"                                           always;

files/sbin/certbot_renew

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
 
-sleep $(($RANDOM % 3600));
+sleep $((RANDOM % 3600));
 /opt/certbot/bin/pip install --upgrade certbot certbot-nginx certbot-dns-ovh
 certbot renew --cert-name netoik.io

netoik-rp.spec

@@ -2,13 +2,13 @@
 
 Name:           %(make name)
 Version:        %(make version)
-Release:        1%{?dist}
+Release:        %(make release)
 Summary:        Netoik Reverse Proxy
 License:        MIT
 URL:            https://git.netoik.io/samuel/netoik-rp
 
 Source0:        %{name}-%{version}.tar.gz
-Buildarch:      noarch
+Buildarch:      %(make build_arch)
 BuildRequires:  make
 Requires:       nginx python3 python-devel (augeas-devel or augeas-libs) gcc openssl