Prepare release 1

.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: weejewel

.github/workflows/codeql.yml

@@ -12,7 +12,6 @@ jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
     permissions:
       actions: read
       contents: read

.github/workflows/deploy-development.yml

@@ -7,14 +7,14 @@ jobs:
   deploy:
     name: Build & Deploy
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
+    if: github.repository_owner == 'spcfox'
     permissions:
       packages: write
       contents: read
     steps:
     - uses: actions/checkout@v4
       with:
-        ref: production
+        ref: master
 
     - name: Set up QEMU
       uses: docker/setup-qemu-action@v3
@@ -34,4 +34,4 @@ jobs:
       with:
         push: true
         platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8
-        tags: ghcr.io/wg-easy/wg-easy:development
+        tags: ghcr.io/spcfox/amnezia-wg-easy:development

.github/workflows/deploy-nightly.yml

@@ -1,39 +0,0 @@
-name: Build & Publish Nightly
-
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: "0 0 * * *"
-
-jobs:
-  deploy:
-    name: Build & Deploy
-    runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
-    permissions:
-      packages: write
-      contents: read
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        ref: production
-
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v3
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
-
-    - name: Login to GitHub Container Registry
-      uses: docker/login-action@v3
-      with:
-        registry: ghcr.io
-        username: ${{ github.actor }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Build & Publish Docker Image
-      uses: docker/build-push-action@v5
-      with:
-        push: true
-        platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8
-        tags: ghcr.io/wg-easy/wg-easy:nightly

.github/workflows/deploy.yml

@@ -10,7 +10,7 @@ jobs:
   deploy:
     name: Build & Deploy
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
+    if: github.repository_owner == 'spcfox'
     permissions:
       packages: write
       contents: read
@@ -40,4 +40,4 @@ jobs:
       with:
         push: true
         platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8
-        tags: ghcr.io/wg-easy/wg-easy:latest, ghcr.io/wg-easy/wg-easy:${{ env.RELEASE }}
+        tags: ghcr.io/spcfox/amnezia-wg-easy:latest, ghcr.io/spcfox/amnezia-wg-easy:${{ env.RELEASE }}

.github/workflows/lint.yml

@@ -11,7 +11,6 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.github/workflows/npm-update-bot.yml

@@ -10,12 +10,11 @@ jobs:
   npmupbot:
     name: NPM Update Bot 🤖
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          repository: wg-easy/wg-easy
+          repository: spcfox/amnezia-wg-easy
           ref: master
       - name: Setup Node
         uses: actions/setup-node@v4

.github/workflows/stale.yml

@@ -1,35 +0,0 @@
-# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
-#
-# You can adjust the behavior by modifying this file.
-# For more information, see:
-# https://github.com/actions/stale
-name: Mark stale issues and pull requests
-
-on:
-  workflow_dispatch:
-  schedule:
-  - cron: '*/5 * * * *'
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-    if: github.repository_owner == 'wg-easy'
-    permissions:
-      issues: write
-      pull-requests: write
-
-    steps:
-    - uses: actions/stale@v9
-      with:
-          days-before-issue-stale: 30
-          days-before-issue-close: 14
-          stale-issue-label: "stale"
-          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
-          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
-          days-before-pr-stale: 30
-          days-before-pr-close: 14
-          stale-pr-message: "This PR is stale because it has been open for 30 days with no activity."
-          close-pr-message: "This PR was closed because it has been inactive for 14 days since being marked as stale."
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          operations-per-run: 100

README.md

@@ -35,16 +35,24 @@ $ exit
 
 And log in again.
 
-### 2. Set environment variables
+### 2. Run AmneziaWG Easy
-
-In [.env](.env) set the following environment variables:
-- Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname.
-- Replace `YOUR_ADMIN_PASSWORD` with a password to log in on the Web UI.
-
-### 3. Build & run the Docker image
 
 ```bash
-$ docker-compose up -d
+$ docker run -d \
+  --name=amnezia-wg-easy \
+  -e LANG=en \
+  -e WG_HOST=<b>🚨YOUR_SERVER_IP</b> \
+  -e PASSWORD=<b>🚨YOUR_ADMIN_PASSWORD</b> \
+  -v ~/.amnezia-wg-easy:/etc/wireguard \
+  -p 51820:51820/udp \
+  -p 51821:51821/tcp \
+  --cap-add=NET_ADMIN \
+  --cap-add=SYS_MODULE \
+  --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
+  --sysctl="net.ipv4.ip_forward=1" \
+  --device=/dev/net/tun:/dev/net/tun \
+  --restart unless-stopped \
+  ghcr.io/spcfox/amnezia-wg-easy
 ```
 
 The Web UI will now be available on `http://0.0.0.0:51821`.
@@ -58,6 +66,7 @@ These options can be configured by setting environment variables using `-e KEY="
 | Env | Default | Example | Description |
 | - | - | - | - |
 | `LANGUAGE` | `en` | `de` | Web UI language. List of available languages in [i18n.js]() |
+| `CHECK_UPDATE` | `true` | `false` | Check for a new version and display a notification about its availability |
 | `PORT` | `51821` | `6789` | TCP port for Web UI. |
 | `WEBUI_HOST` | `0.0.0.0` | `localhost` | IP address web UI binds to. |
 | `PASSWORD` | - | `foobar123` | When set, requires a password when logging in to the Web UI. |
@@ -78,10 +87,20 @@ These options can be configured by setting environment variables using `-e KEY="
 | `JMAX` | `1000` | `250` | Junk packet maximum size — maximum size for Junk packets. |
 | `S1` | `random` | `75` | Init packet junk size — the size of random data that will be added to the init packet, the size of which is initially fixed. |
 | `S2` | `random` | `75` | Response packet junk size — the size of random data that will be added to the response packet, the size of which is initially fixed. |
-| `H1` | `random` | `59869232` | Init packet magic header — the header of the first byte of the handshake. Must be < uint_max. |
+| `H1` | `random` | `1234567891` | Init packet magic header — the header of the first byte of the handshake. Must be < uint_max. |
-| `H2` | `random` | `869587260` | Response packet magic header — header of the first byte of the handshake response. Must be < uint_max. |
+| `H2` | `random` | `1234567892` | Response packet magic header — header of the first byte of the handshake response. Must be < uint_max. |
-| `H3` | `random` | `1632311713` | Underload packet magic header — UnderLoad packet header. Must be < uint_max. |
+| `H3` | `random` | `1234567893` | Underload packet magic header — UnderLoad packet header. Must be < uint_max. |
-| `H4` | `random` | `820711365` | Transport packet magic header — header of the packet of the data packet. Must be < uint_max. |
+| `H4` | `random` | `1234567894` | Transport packet magic header — header of the packet of the data packet. Must be < uint_max. |
+
+## Updating
+
+To update to the latest version, simply run:
+
+```bash
+docker stop amnezia-wg-easy
+docker rm amnezia-wg-easy
+docker pull ghcr.io/spcfox/amnezia-wg-easy
+```
 
 ## Thanks
 

contributing.md

@@ -1,6 +1,6 @@
-# Contributing to wg-easy
+# Contributing to amnezia-wg-easy
 
-First and foremost, thank you! We appreciate that you want to contribute to wg-easy, your time is valuable, and your contributions mean a lot to us.
+First and foremost, thank you! We appreciate that you want to contribute to amnezia-wg-easy, your time is valuable, and your contributions mean a lot to us.
 
 
 ## Important!
@@ -25,14 +25,13 @@ Creating an issue is the simplest form of contributing to a project. But there a
 - Bug reports
 
 
-## Showing support for wg-easy
+## Showing support for amnezia-wg-easy
 
 Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.
 
-Don't have time to contribute? No worries, here are some other ways to show your support for wg-easy:
+Don't have time to contribute? No worries, here are some other ways to show your support for amnezia-wg-easy:
 
-- star the [project](https://github.com/wg-easy/wg-easy)
+- star the [project](https://github.com/spcfox/amnezia-wg-easy)
-- tweet your support for wg-easy
 
 
 ## Issues
@@ -67,14 +66,14 @@ Please be as descriptive as possible when creating an issue. Give us the informa
 
 - **description**: (required) What is the bug you're experiencing? How are you using this library/app?
 - **OS**: (required) what operating system are you on?
-- **version**: (required) please note the version of wg-easy are you using
+- **version**: (required) please note the version of amnezia-wg-easy are you using
 - **error messages**: (required) please paste any error messages into the issue, or a [gist](https://gist.github.com/)
 - **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using
 
 
 ### Closing issues
 
-The original poster or the maintainers of wg-easy may close an issue at any time. Typically, but not exclusively, issues are closed when:
+The original poster or the maintainers of amnezia-wg-easy may close an issue at any time. Typically, but not exclusively, issues are closed when:
 
 - The issue is resolved
 - The project's maintainers have determined the issue is out of scope

docker-compose.dev.yml

@@ -1,10 +0,0 @@
-version: "3.8"
-services:
-  wg-easy:
-    image: wg-easy
-    command: npm run serve
-    volumes:
-      - ./src/:/app/
-    environment:
-      # - PASSWORD=p
-      - WG_HOST=192.168.1.233

docs/changelog.json

@@ -1,13 +1,3 @@
 {
-  "1": "Initial version. Enjoy!",
+  "1": "Initial version. Enjoy!"
-  "2": "You can now rename a client, and update the address. Enjoy!",
-  "3": "Many improvements and small changes. Enjoy!",
-  "4": "Now with pretty charts for client's network speed. Enjoy!",
-  "5": "Many small improvements & feature requests. Enjoy!",
-  "6": "Many small performance improvements & bug fixes. Enjoy!",
-  "7": "Improved the look & performance of the upload/download chart.",
-  "8": "Updated to Node.js v18.",
-  "9": "Fixed issue running on devices with older kernels.",
-  "10": "Added sessionless HTTP API auth & automatic dark mode."
-  "11": "Multilanguage Support & various bugfixes"
 }

package-lock.json

@@ -1,11 +0,0 @@
-{
-  "name": "wg-easy",
-  "version": "1.0.1",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "": {
-      "version": "1.0.1"
-    }
-  }
-}

package.json

@@ -1,8 +0,0 @@
-{
-  "version": "1.0.1",
-  "scripts": {
-    "build": "DOCKER_BUILDKIT=1 docker build --tag wg-easy .",
-    "serve": "docker-compose -f docker-compose.yml -f docker-compose.dev.yml up",
-    "start": "docker run --env WG_HOST=0.0.0.0 --name wg-easy --cap-add=NET_ADMIN --cap-add=SYS_MODULE --sysctl=\"net.ipv4.conf.all.src_valid_mark=1\" --mount type=bind,source=\"$(pwd)\"/config,target=/etc/wireguard -p 51820:51820/udp -p 51821:51821/tcp wg-easy"
-  }
-}

src/config.js

@@ -2,6 +2,7 @@
 
 const { release } = require('./package.json');
 
+module.exports.CHECK_UPDATE = process.env.CHECK_UPDATE ? process.env.CHECK_UPDATE.toLowerCase() === 'true' : true;
 module.exports.RELEASE = release;
 module.exports.PORT = process.env.PORT || 51821;
 module.exports.WEBUI_HOST = process.env.WEBUI_HOST || '0.0.0.0';
@@ -31,8 +32,8 @@ module.exports.WG_POST_DOWN = process.env.WG_POST_DOWN || '';
 module.exports.LANG = process.env.LANGUAGE || 'en';
 
 const getRandomInt = (min, max) => min + Math.floor(Math.random() * (max - min));
-const getRandomJunkSize = () => getRandomInt(15, 150)
+const getRandomJunkSize = () => getRandomInt(15, 150);
-const getRandomHeader = () => getRandomInt(1, 2_147_483_647)
+const getRandomHeader = () => getRandomInt(1, 2_147_483_647);
 
 module.exports.JC = process.env.JC || getRandomInt(3, 10);
 module.exports.JMIN = process.env.JMIN || 50;

src/lib/Server.js

@@ -13,6 +13,7 @@ const ServerError = require('./ServerError');
 const WireGuard = require('../services/WireGuard');
 
 const {
+  CHECK_UPDATE,
   PORT,
   WEBUI_HOST,
   RELEASE,
@@ -37,6 +38,12 @@ module.exports = class Server {
         },
       }))
 
+      .get('/api/check-update', (Util.promisify(async () => {
+        return {
+          checkUpdate: CHECK_UPDATE,
+        };
+      })))
+
       .get('/api/release', (Util.promisify(async () => {
         return RELEASE;
       })))

src/lib/WireGuard.js

@@ -75,7 +75,6 @@ module.exports = class WireGuard {
             clients: {},
           };
 
-
           debug('Configuration generated.');
         }
 

src/package-lock.json

@@ -1,12 +1,12 @@
 {
-  "name": "wg-easy",
+  "name": "amnezia-wg-easy",
-  "version": "1.0.1",
+  "version": "1.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "wg-easy",
+      "name": "amnezia-wg-easy",
-      "version": "1.0.1",
+      "version": "1.0.0",
       "license": "GPL",
       "dependencies": {
         "bcryptjs": "^2.4.3",
@@ -2380,20 +2380,6 @@
       "dev": true,
       "peer": true
     },
-    "node_modules/fsevents": {
-      "version": "2.3.3",
-      "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
-      "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
-      "dev": true,
-      "hasInstallScript": true,
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
-      }
-    },
     "node_modules/function-bind": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",

src/package.json

@@ -1,8 +1,8 @@
 {
-  "release": "11",
+  "release": "1",
-  "name": "wg-easy",
+  "name": "amnezia-wg-easy",
-  "version": "1.0.1",
+  "version": "1.0.0",
-  "description": "The easiest way to run WireGuard VPN + Web-based Admin UI.",
+  "description": "The easiest way to run AmneziaWG VPN + Web-based Admin UI.",
   "main": "server.js",
   "scripts": {
     "serve": "DEBUG=Server,WireGuard nodemon server.js",
@@ -10,7 +10,7 @@
     "lint": "eslint .",
     "buildcss": "npx tailwindcss -i ./www/src/css/app.css -o ./www/css/app.css"
   },
-  "author": "Emile Nijssen",
+  "author": "Viktor Yudov",
   "license": "GPL",
   "dependencies": {
     "bcryptjs": "^2.4.3",

src/www/index.html

@@ -40,6 +40,22 @@
         </h1>
         <h2 class="text-sm text-gray-400 dark:text-neutral-400 mb-10"></h2>
 
+        <div v-if="latestRelease"
+          class="bg-red-800 dark:bg-red-100 p-4 text-white dark:text-red-600 text-sm font-small mb-10 rounded-md shadow-lg"
+          :title="`v${currentRelease} → v${latestRelease.version}`">
+          <div class="container mx-auto flex flex-row flex-auto items-center">
+            <div class="flex-grow">
+              <p class="font-bold">{{$t("updateAvailable")}}</p>
+              <p>{{latestRelease.changelog}}</p>
+            </div>
+
+            <a href="https://github.com/spcfox/amnezia-wg-easy#updating" target="_blank"
+              class="p-3 rounded-md bg-white dark:bg-red-100 float-right font-sm font-semibold text-red-800 dark:text-red-600 flex-shrink-0 border-2 border-red-800 dark:border-red-600 hover:border-white dark:hover:border-red-600 hover:text-white dark:hover:text-red-100 hover:bg-red-800 dark:hover:bg-red-600 transition-all">
+              {{$t("update")}} →
+            </a>
+          </div>
+        </div>
+
         <div class="shadow-md rounded-lg bg-white dark:bg-neutral-700 overflow-hidden">
           <div class="flex flex-row flex-auto items-center p-3 px-5 border-b-2 border-gray-100 dark:border-neutral-600">
             <div class="flex-grow">

src/www/js/api.js

@@ -29,6 +29,13 @@ class API {
     return json;
   }
 
+  async checkUpdate() {
+    return this.call({
+      method: 'get',
+      path: '/check-update',
+    });
+  }
+
   async getRelease() {
     return this.call({
       method: 'get',

src/www/js/app.js

@@ -5,6 +5,8 @@
 
 'use strict';
 
+const CHANGELOG_URL = 'https://raw.githubusercontent.com/spcfox/amnezia-wg-easy/production/docs/changelog.json';
+
 function bytes(bytes, decimals, kib, maxunit) {
   kib = kib || false;
   if (bytes === 0) return '0 B';
@@ -299,8 +301,11 @@ new Vue({
         i18n.locale = lang;
       }
 
+      const checkUpdate = await this.api.checkUpdate();
+      if (!checkUpdate) return;
+
       const currentRelease = await this.api.getRelease();
-      const latestRelease = await fetch('https://wg-easy.github.io/wg-easy/changelog.json')
+      const latestRelease = await fetch(CHANGELOG_URL)
         .then((res) => res.json())
         .then((releases) => {
           const releasesArray = Object.entries(releases).map(([version, changelog]) => ({

src/www/manifest.json

@@ -1,11 +1,11 @@
 {
-  "name": "WireGuard",
+  "name": "AmneziaWG",
   "display": "standalone",
   "background_color": "#fff",
   "icons": [
     {
-      "src": "img/favicon.png",
+      "src": "img/favicon.ico",
-      "type": "image/png"
+      "type": "image/x-icon"
     }
   ]
 }

wg-easy.service

@@ -1,22 +0,0 @@
-[Unit]
-Description=Wireguard VPN + + Web-based Admin UI
-After=network-online.target nss-lookup.target
-
-[Service]
-Environment="WG_HOST=raspberrypi.local" # Change this to your host's public address or static public ip.
-Environment="PASSWORD=REPLACEME" # When set, requires a password when logging in to the Web UI, to disable add a hashtag
-#Environment="WG_DEFAULT_ADDRESS=10.0.8.x" #Clients IP address range.
-#Environment="WG_DEFAULT_DNS=10.0.8.1, 1.1.1.1" #DNS server clients will use. If set to blank value, clients will not use any DNS.
-#Environment="WG_ALLOWED_IPS=0.0.0.0/0,::/0" #Allowed IPs clients will use.
-#Environment="WG_DEVICE=ens1" #Ethernet device the wireguard traffic should be forwarded through.
-#Environment="PORT=80" #TCP port for Web UI. Default : 51821
-#Environment="WG_MTU=1420" #The MTU the clients will use. Server uses default WG MTU
-#Environment="WG_PERSISTENT_KEEPALIVE=25" #Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive.
-Type=simple
-RemainAfterExit=no
-ExecStart=/usr/bin/env node /app/server.js
-Restart=on-failure
-RestartSec=1
-
-[Install]
-WantedBy=multi-user.target