Merge branch 'master' into production

2025-01-09 06:25:51 +08:00 · 2023-12-17 22:45:41 +01:00 · 2023-12-17 22:45:41 +01:00 · ca8f577d6a
commit ca8f577d6a
parent 0950e0450c 106387f71a
13 changed files with 2948 additions and 1817 deletions
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: weejewel
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
--- a/.github/workflows/deploy-nightly.yml
+++ b/.github/workflows/deploy-nightly.yml
@ -1,4 +1,4 @@
-name: Build & Publish Docker Image to Docker Hub
+name: Build & Publish Nightly Docker Image to GitHub Container Registry

 on:
  workflow_dispatch:
@ -9,8 +9,11 @@ jobs:
  deploy:
    name: Build & Deploy
    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
    steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
      with:
        ref: production

@ -20,19 +23,19 @@ jobs:
    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v1

-    - name: Login to DockerHub
-      uses: docker/login-action@v1 
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v3
      with:
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
          
-    # Set environment variables
-    - run: echo RELEASE=$(cat ./src/package.json | jq -r .release) >> $GITHUB_ENV
+    - name: Set environment variables
+      run: echo RELEASE=$(cat ./src/package.json | jq -r .release) >> $GITHUB_ENV
    
-    # Build & Publish
    - name: Build & Publish Docker Image
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v5
      with:
        push: true
        platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8
-        tags: weejewel/wg-easy:nightly, weejewel/wg-easy:${{ env.RELEASE }}-nightly
+        tags: ghcr.io/wg-easy/wg-easy:nightly, ghcr.io/wg-easy/wg-easy:${{ env.RELEASE }}-nightly
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@ -1,18 +1,20 @@
-name: Build & Publish Docker Image to Docker Hub
+name: Build & Publish Docker Image to GitHub Container Registry

 on:
  workflow_dispatch:
  push:
    branches:
      - production
-      - production/**

 jobs:
  deploy:
    name: Build & Deploy
    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
    steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
      with:
        ref: production

@ -22,19 +24,19 @@ jobs:
    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v1

-    - name: Login to DockerHub
-      uses: docker/login-action@v1 
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v3
      with:
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
          
-    # Set environment variables
-    - run: echo RELEASE=$(cat ./src/package.json | jq -r .release) >> $GITHUB_ENV
+    - name: Set environment variables
+      run: echo RELEASE=$(cat ./src/package.json | jq -r .release) >> $GITHUB_ENV
    
-    # Build & Publish
    - name: Build & Publish Docker Image
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v5
      with:
        push: true
        platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8
-        tags: weejewel/wg-easy:latest, weejewel/wg-easy:${{ env.RELEASE }}
+        tags: ghcr.io/wg-easy/wg-easy:latest, ghcr.io/wg-easy/wg-easy:${{ env.RELEASE }}
--- a/19
+++ b/19
@ -1,15 +1,4 @@
-# There's an issue with node:16-alpine.
-# On Raspberry Pi, the following crash happens:
-
-# #FailureMessage Object: 0x7e87753c
-# #
-# # Fatal error in , line 0
-# # unreachable code
-# #
-# #
-# #
-
-FROM docker.io/library/node:14-alpine@sha256:dc92f36e7cd917816fa2df041d4e9081453366381a00f40398d99e9392e78664 AS build_node_modules
+FROM docker.io/library/node:20-alpine AS build_node_modules

 # Copy Web UI
 COPY src/ /app/
@ -18,7 +7,7 @@ RUN npm ci --production

 # Copy build result to a new image.
 # This saves a lot of disk space.
-FROM docker.io/library/node:14-alpine@sha256:dc92f36e7cd917816fa2df041d4e9081453366381a00f40398d99e9392e78664
+FROM docker.io/library/node:20-alpine
 COPY --from=build_node_modules /app /app

 # Move node_modules one directory up, so during development
@ -30,11 +19,9 @@ COPY --from=build_node_modules /app /app
 # than what runs inside of docker.
 RUN mv /app/node_modules /node_modules

-# Enable this to run `npm run serve`
-RUN npm i -g nodemon
-
 # Install Linux packages
 RUN apk add -U --no-cache \
+  iptables \
  wireguard-tools \
  dumb-init

--- a/README.md
+++ b/README.md
@ -1,10 +1,11 @@
 # WireGuard Easy

-[![Build & Publish Docker Image to Docker Hub](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml/badge.svg?branch=production)](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml)
-[![Lint](https://github.com/WeeJeWel/wg-easy/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/WeeJeWel/wg-easy/actions/workflows/lint.yml)
-[![Docker](https://img.shields.io/docker/v/weejewel/wg-easy/latest)](https://hub.docker.com/r/weejewel/wg-easy)
-[![Docker](https://img.shields.io/docker/pulls/weejewel/wg-easy.svg)](https://hub.docker.com/r/weejewel/wg-easy)
+[![Build & Publish Docker Image to Docker Hub](https://github.com/wg-easy/wg-easy/actions/workflows/deploy.yml/badge.svg?branch=production)](https://github.com/wg-easy/wg-easy/actions/workflows/deploy.yml)
+[![Lint](https://github.com/wg-easy/wg-easy/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/wg-easy/wg-easy/actions/workflows/lint.yml)
+[![Docker](https://img.shields.io/docker/v/wg-easy/wg-easy/latest)](https://hub.docker.com/r/wg-easy/wg-easy)
+[![Docker](https://img.shields.io/docker/pulls/wg-easy/wg-easy.svg)](https://hub.docker.com/r/wg-easy/wg-easy)
 [![Sponsor](https://img.shields.io/github/sponsors/weejewel)](https://github.com/sponsors/WeeJeWel)
+![GitHub Stars](https://img.shields.io/github/stars/wg-easy/wg-easy)

 You have found the easiest way to install & manage WireGuard on any Linux host!

@ -59,7 +60,7 @@ $ docker run -d \
  --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
  --sysctl="net.ipv4.ip_forward=1" \
  --restart unless-stopped \
-  weejewel/wg-easy
+  ghcr.io/wg-easy/wg-easy
 </pre>

 > 💡 Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname.
@ -82,16 +83,17 @@ These options can be configured by setting environment variables using `-e KEY="
 | - | - | - | - |
 | `PASSWORD` | - | `foobar123` | When set, requires a password when logging in to the Web UI. |
 | `WG_HOST` | - | `vpn.myserver.com` | The public hostname of your VPN server. |
+| `WG_DEVICE` | `eth0` | `ens6f0` | Ethernet device the wireguard traffic should be forwarded through. |
 | `WG_PORT` | `51820` | `12345` | The public UDP port of your VPN server. WireGuard will always listen on `51820` inside the Docker container. |
 | `WG_MTU` | `null` | `1420` | The MTU the clients will use. Server uses default WG MTU. |
 | `WG_PERSISTENT_KEEPALIVE` | `0` | `25` | Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive. |
 | `WG_DEFAULT_ADDRESS` | `10.8.0.x` | `10.6.0.x` | Clients IP address range. |
 | `WG_DEFAULT_DNS` | `1.1.1.1` | `8.8.8.8, 8.8.4.4` | DNS server clients will use. |
 | `WG_ALLOWED_IPS` | `0.0.0.0/0, ::/0` | `192.168.15.0/24, 10.0.1.0/24` | Allowed IPs clients will use. |
-| `WG_PRE_UP` | `...` | - | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L19) for the default value. |
-| `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L20) for the default value. |
-| `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L27) for the default value. |
-| `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L28) for the default value. |
+| `WG_PRE_UP` | `...` | - | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L19) for the default value. |
+| `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L20) for the default value. |
+| `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L27) for the default value. |
+| `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L28) for the default value. |

 > If you change `WG_PORT`, make sure to also change the exposed port.

@ -102,11 +104,12 @@ To update to the latest version, simply run:
 ```bash
 docker stop wg-easy
 docker rm wg-easy
-docker pull weejewel/wg-easy
+docker pull ghcr.io/wg-easy/wg-easy
 ```

 And then run the `docker run -d \ ...` command above again.

 ## Common Use Cases

-* [Using WireGuard-Easy with Pi-Hole](https://github.com/WeeJeWel/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)
+* [Using WireGuard-Easy with Pi-Hole](https://github.com/wg-easy/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)
+* [Using WireGuard-Easy with nginx/SSL](https://github.com/wg-easy/wg-easy/wiki/Using-WireGuard-Easy-with-nginx-SSL)
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -18,7 +18,7 @@ services:
      # - WG_PRE_DOWN=echo "Pre Down" > /etc/wireguard/pre-down.txt
      # - WG_POST_DOWN=echo "Post Down" > /etc/wireguard/post-down.txt
      
-    image: weejewel/wg-easy
+    image: ghcr.io/wg-easy/wg-easy
    container_name: wg-easy
    volumes:
      - .:/etc/wireguard
--- a/src/config.js
+++ b/src/config.js
@ -6,6 +6,7 @@ module.exports.RELEASE = release;
 module.exports.PORT = process.env.PORT || 51821;
 module.exports.PASSWORD = process.env.PASSWORD;
 module.exports.WG_PATH = process.env.WG_PATH || '/etc/wireguard/';
+module.exports.WG_DEVICE = process.env.WG_DEVICE || 'eth0';
 module.exports.WG_HOST = process.env.WG_HOST;
 module.exports.WG_PORT = process.env.WG_PORT || 51820;
 module.exports.WG_MTU = process.env.WG_MTU || null;
@ -18,7 +19,7 @@ module.exports.WG_ALLOWED_IPS = process.env.WG_ALLOWED_IPS || '0.0.0.0/0, ::/0';

 module.exports.WG_PRE_UP = process.env.WG_PRE_UP || '';
 module.exports.WG_POST_UP = process.env.WG_POST_UP || `
-iptables -t nat -A POSTROUTING -s ${module.exports.WG_DEFAULT_ADDRESS.replace('x', '0')}/24 -o eth0 -j MASQUERADE;
+iptables -t nat -A POSTROUTING -s ${module.exports.WG_DEFAULT_ADDRESS.replace('x', '0')}/24 -o ${module.exports.WG_DEVICE} -j MASQUERADE;
 iptables -A INPUT -p udp -m udp --dport 51820 -j ACCEPT;
 iptables -A FORWARD -i wg0 -j ACCEPT;
 iptables -A FORWARD -o wg0 -j ACCEPT;
--- a/src/lib/Server.js
+++ b/src/lib/Server.js
@ -104,7 +104,7 @@ module.exports = class Server {
          .replace(/(-{2,}|-$)/g, '-')
          .replace(/-$/, '')
          .substring(0, 32);
-        res.header('Content-Disposition', `attachment; filename="${configName}.conf"`);
+        res.header('Content-Disposition', `attachment; filename="${configName || clientId}.conf"`);
        res.header('Content-Type', 'text/plain');
        res.send(config);
      }))
--- a/src/package-lock.json
+++ b/src/package-lock.json
--- a/src/package.json
+++ b/src/package.json
@ -5,7 +5,7 @@
  "description": "",
  "main": "server.js",
  "scripts": {
-    "serve": "DEBUG=Server,WireGuard nodemon server.js",
+    "serve": "DEBUG=Server,WireGuard node --watch server.js",
    "serve-with-password": "PASSWORD=wg npm run serve",
    "lint": "eslint ."
  },
@ -22,12 +22,7 @@
    "eslint": "^7.27.0",
    "eslint-config-athom": "^2.1.0"
  },
-  "nodemonConfig": {
-    "ignore": [
-      "www/*"
-    ]
-  },
  "engines": {
-    "node": "14"
+    "node": "20"
  }
 }
--- a/src/www/index.html
+++ b/src/www/index.html
@ -513,7 +513,7 @@
    <p v-cloak class="text-center m-10 text-gray-300 text-xs">Made by <a target="_blank" class="hover:underline"
        href="https://emilenijssen.nl/?ref=wg-easy">Emile Nijssen</a> · <a class="hover:underline"
        href="https://github.com/sponsors/WeeJeWel" target="_blank">Donate</a> · <a class="hover:underline"
-        href="https://github.com/weejewel/wg-easy" target="_blank">GitHub</a></p>
+        href="https://github.com/wg-easy/wg-easy" target="_blank">GitHub</a></p>


  </div>
--- a/src/www/js/app.js
+++ b/src/www/js/app.js
@ -270,7 +270,7 @@ new Vue({

    Promise.resolve().then(async () => {
      const currentRelease = await this.api.getRelease();
-      const latestRelease = await fetch('https://weejewel.github.io/wg-easy/changelog.json')
+      const latestRelease = await fetch('https://wg-easy.github.io/wg-easy/changelog.json')
        .then(res => res.json())
        .then(releases => {
          const releasesArray = Object.entries(releases).map(([version, changelog]) => ({