Merge in latest news from "mother"-project

.commitlintrc.mjs

@@ -0,0 +1,26 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'config',
+        'doc',
+        'feat',
+        'fix',
+        'hotfix',
+        'i18n',
+        'refactor',
+        'revert',
+        'test',
+        'ui',
+        'wip',
+        'publish',
+      ],
+    ],
+  },
+  ignores: [(message) => message.includes('WIP'), (message) => message.includes('wip')],
+};

.env.sample

@@ -0,0 +1,53 @@
+## Required variables section ##
+
+# Host port mappings
+WEB_SERVER_PORT=3000
+SSH_SERVER_PORT=2222
+
+# Hostname and URL
+FQDN=your.domain.com
+NEXTAUTH_URL=https://your.domain.com
+
+# Secrects
+NEXTAUTH_SECRET=your-secret
+CRONJOB_KEY=your-other-secret
+
+# UID:GID must match the user and group ID of the host folders and must be > 1000
+# If you want to use a different user than 1001:1001, you must rebuild the image yourself.
+UID=1001
+GID=1001
+
+# Config and data folders (volume mounts)
+# The host folders must be owned by the user with UID and GID specified above
+CONFIG_PATH=./config
+SSH_PATH=./ssh
+SSH_HOST=./ssh_host
+BORG_REPOSITORY_PATH=./repos
+TMP_PATH=./tmp
+LOGS_PATH=./logs
+
+## Optional variables section ##
+
+# LAN feature
+FQDN_LAN=
+SSH_SERVER_PORT_LAN=
+
+# Disable the DELETE feature
+#DISABLE_DELETE_REPO=true
+
+# Disable the integrations (API tokens to CRUD repositories)
+#DISABLE_INTEGRATIONS=true
+
+# Hide the SSH port in the UI : quickcommands & wizard
+#HIDE_SSH_PORT=true
+
+# SMTP server settings
+MAIL_SMTP_FROM=
+MAIL_SMTP_HOST=
+MAIL_SMTP_PORT=
+MAIL_SMTP_LOGIN=
+MAIL_SMTP_PWD=
+MAIL_REJECT_SELFSIGNED_TLS=
+
+# Force app to start on IPv6
+#HOSTNAME=::

.github/FUNDING.yml

@@ -6,7 +6,7 @@ open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
+liberapay: R4VEN
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
 lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

.github/workflows/bats.yml

@@ -0,0 +1,26 @@
+name: Bats
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+jobs:
+  bats-test:
+    name: Run bats tests against shells
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build container & run bats tests
+        run: |
+          docker compose -f tests/bats/docker-compose.yml up --abort-on-container-exit --build

.github/workflows/docker-image-develop.yml

@@ -0,0 +1,35 @@
+name: Build and Push Docker Image for Develop Branch
+
+on:
+  push:
+    branches:
+      - 'develop'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Update package.json version
+        run: |
+          COMMIT=$(git rev-parse --short HEAD)
+          echo "Current Commit: $COMMIT"
+          jq '.version = "develop-'$COMMIT'"' package.json > package.tmp.json
+          mv package.tmp.json package.json
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64 # linux/arm/v7 arm32 is not supported by node20 https://github.com/nodejs/docker-node/issues/1946
+          tags: borgwarehouse/borgwarehouse:develop

.github/workflows/docker-image-latest.yml

@@ -1,34 +1,29 @@
 name: Build and Push Docker Image
 
 on:
-  push:
-    branches:
-      - 'main'
+    push:
+        branches:
+            - 'main'
 
 jobs:
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-      -
-        name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Build and push
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          push: true
-          platforms: linux/amd64,linux/arm64,linux/arm
-          tags: borgwarehouse/borgwarehouse:latest
+    docker:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v3
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+            - name: Login to Docker Hub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Build and push
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  push: true
+                  platforms: linux/amd64,linux/arm64 # linux/arm/v7 arm32 is not supported by node20 https://github.com/nodejs/docker-node/issues/1946
+                  tags: borgwarehouse/borgwarehouse:latest

.github/workflows/docker-image-release.yml

@@ -1,38 +1,32 @@
 name: Build and Push Docker Image on Release
 
 on:
-  release:
-    types:
-      - published
+    release:
+        types:
+            - published
 
 jobs:
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-      -
-        name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Get Release Tag
-        id: get_release_tag
-        run: echo "::set-output name=TAG::${{ github.event.release.tag_name }}"
-      -
-        name: Build and push
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          push: true
-          platforms: linux/amd64,linux/arm64
-          tags: borgwarehouse/borgwarehouse:${{ steps.get_release_tag.outputs.TAG }}
+    docker:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v3
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+            - name: Login to Docker Hub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Get Release Tag
+              id: get_release_tag
+              run: echo "::set-output name=TAG::${{ github.event.release.tag_name }}"
+            - name: Build and push
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  push: true
+                  platforms: linux/amd64,linux/arm64 # linux/arm/v7 arm32 is not supported by node20 https://github.com/nodejs/docker-node/issues/1946
+                  tags: borgwarehouse/borgwarehouse:${{ steps.get_release_tag.outputs.TAG }}

.github/workflows/docker-image-test.yml

@@ -1,24 +1,21 @@
-name: Test Docker Container Build on Pull Request
+name: Test to build docker container on Pull Request
 
 on:
   pull_request:
     branches:
       - main
+      - develop
 
 jobs:
   build-container:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v4
-      -
-        name: Set up QEMU
+      - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-      -
-        name: Set up Docker Buildx
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      -
-        name: Build Docker Container
+      - name: Build BorgWarehouse Container
         run: |
           docker buildx build --platform linux/amd64,linux/arm64 -t borgwarehouse:pr-${{ github.event.pull_request.number }} .

.gitignore

@@ -111,4 +111,7 @@ config/repo.json
 config/users.json
 
 # docker files
-docker-compose.yml
+docker-compose.yml
+
+# Commit tests docker-compose
+!tests/bats/docker-compose.yml