Merge branch 'thedevs-network:main' into main

Author: evilmooncake

.example.env

@@ -11,9 +11,17 @@ DEFAULT_DOMAIN=localhost:3000
 JWT_SECRET=
 
 # Optional - Database client. Available clients for the supported databases:
-# pg | pg-native | sqlite3 | better-sqlite3 | mysql | mysql2 | oracledb | tedious
-DB_CLIENT=sqlite3
-# SQL database credential details, only if you use Postgres or MySQL
+# pg | better-sqlite3 | mysql2
+# other supported drivers that you can use but you have to manually install them with npm:
+# pg-native | sqlite3 | mysql
+DB_CLIENT=better-sqlite3
+
+# Optional - SQLite database file path
+# Only if you're using SQLite
+DB_FILENAME=db/data
+
+# Optional - SQL database credential details
+# Only if you're using Postgres or MySQL
 DB_HOST=localhost
 DB_PORT=5432
 DB_NAME=kutt
@@ -26,6 +34,15 @@ DB_POOL_MAX=10
 # Optional - Generated link length
 LINK_LENGTH=6
 
+# Optional - Alphabet used to generate custom addresses
+# Default value omits o, O, 0, i, I, l, 1, and j to avoid confusion when reading the URL
+LINK_CUSTOM_ALPHABET=abcdefghkmnpqrstuvwxyzABCDEFGHKLMNPQRSTUVWXYZ23456789
+
+# Optional - Tells the app that it's running behind a proxy server
+# and that it should get the IP address from that proxy server
+# if you're not using a proxy server then set this to false, otherwise users can override their IP address
+TRUST_PROXY=true
+
 # Optional - Redis host and port
 REDIS_ENABLED=false
 REDIS_HOST=127.0.0.1
@@ -56,7 +73,7 @@ CUSTOM_DOMAIN_USE_HTTPS=false
 # More info on the configuration on http://nodemailer.com/.
 MAIL_ENABLED=false
 MAIL_HOST=
-MAIL_PORT=
+MAIL_PORT=587
 MAIL_SECURE=true
 MAIL_USER=
 MAIL_FROM=

.github/workflows/docker-build-development.yaml

@@ -0,0 +1,45 @@
+name: docker-build-development
+
+env:
+  dockerhub_repository: "kutt/kutt"
+  dockerhub_tag: "development"
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  dockerhub-build-push:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1 
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          context: .
+          push: true
+          tags: ${{ env.dockerhub_repository }}:${{ env.dockerhub_tag }}
+      -
+        name: Update repo description
+        uses: peter-evans/dockerhub-description@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: ${{ env.dockerhub_repository }}

.github/workflows/docker-build-latest.yaml

@@ -32,6 +32,7 @@ jobs:
         name: Build and push
         uses: docker/build-push-action@v2
         with:
+          platforms: linux/amd64,linux/arm64
           context: .
           push: true
           tags: ${{ env.dockerhub_repository }}:${{ env.dockerhub_tag }}

.github/workflows/docker-build-release.yaml

@@ -30,6 +30,7 @@ jobs:
         name: Build and push
         uses: docker/build-push-action@v2
         with:
+          platforms: linux/amd64,linux/arm64
           context: .
           push: true
           tags: ${{ env.dockerhub_repository }}:${{ github.event.release.tag_name }}, ${{ env.dockerhub_repository }}:latest

README.md

@@ -0,0 +1,3 @@
+# keep this folder in git
+# put supported customization files for styles and such
+# if you're using docker make sure to mount this folder

custom/.gitkeep

@@ -2,9 +2,12 @@ services:
   server:
     build:
       context: .
+    volumes:
+      - custom:/kutt/custom
     environment:
         DB_CLIENT: mysql2
         DB_HOST: mariadb
+        DB_PORT: 3306
         REDIS_ENABLED: true
         REDIS_HOST: redis
         REDIS_PORT: 6379
@@ -38,4 +41,5 @@ services:
     expose:
       - 6379
 volumes:
-  db_data_mariadb:
+  db_data_mariadb:
+  custom:

docker-compose.mariadb.yml

@@ -2,9 +2,12 @@ services:
   server:
     build:
       context: .
+    volumes:
+      - custom:/kutt/custom
     environment:
         DB_CLIENT: pg
         DB_HOST: postgres
+        DB_PORT: 5432
         REDIS_ENABLED: true
         REDIS_HOST: redis
         REDIS_PORT: 6379
@@ -37,4 +40,5 @@ services:
     expose:
       - 6379
 volumes:
-  db_data_pg:
+  db_data_pg:
+  custom:

docker-compose.postgres.yml

@@ -3,7 +3,8 @@ services:
     build:
       context: .
     volumes:
-       - db-data:/var/lib/kutt
+      - db_data_sqlite:/var/lib/kutt
+      - custom:/kutt/custom
     environment:
       DB_FILENAME: "/var/lib/kutt/data.sqlite"
       REDIS_ENABLED: true
@@ -20,4 +21,5 @@ services:
     expose:
       - 6379
 volumes:
-  db-data:
+  db_data_sqlite:
+  custom:

docker-compose.sqlite-redis.yml

@@ -4,9 +4,11 @@ services:
       context: .
     volumes:
        - db_data_sqlite:/var/lib/kutt
+       - custom:/kutt/custom
     environment:
       DB_FILENAME: "/var/lib/kutt/data.sqlite"
     ports:
       - 3000:3000
 volumes:
-  db_data_sqlite:
+  db_data_sqlite:
+  custom: