Renamed project from MicroGuard to MikroGuard

The project name has been updated from MicroGuard to MikroGuard across README, LICENSE, frontend and backend configurations, and Dockerfile. Ensuring all project references are consistent with the new naming convention.
xterm-inator · Apr 30, 2024 · 4b739ed · 4b739ed
1 parent e9a85a7
commit 4b739ed
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 9 deletions.
diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml
@@ -30,6 +30,7 @@ jobs:
       with:
         images: |
           ghcr.io/xterm-inator/microguard
+          ghcr.io/xterm-inator/mikroguard
         tags: |
           type=ref,event=branch
           type=ref,event=pr

diff --git a/LICENSE.md b/LICENSE.md
@@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    MicroGuard web-based management tool for handling WireGuard clients on MikroTik routers.
+    MikroGuard web-based management tool for handling WireGuard clients on MikroTik routers.
     Copyright (C) 2023  David Smith
 
     This program is free software: you can redistribute it and/or modify
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    MicroGuard  Copyright (C) 2023  David Smith
+    MikroGuard  Copyright (C) 2023  David Smith
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # MikroGuard
+### **Recently renamed from microguard. For now the microguard ghcr image will continue to be updated inline with the new mikroguard ghcr for backwards compatibility, But would recommend switching to the new image. The only difference is the name and the new mikroguard image won't have versions before v1.1.4
 
 MikroGuard is a robust web-based management tool designed to streamline the handling of WireGuard VPN clients on MikroTik routers. It simplifies user addition, access revocation, and provides a real-time view of connection statistics.
 
-
 | Login | Users | Connection |
 | --- | --- | --- |
 ![login](https://github.com/xterm-inator/MikroGuard/assets/7698065/3ea6b5b0-b9ca-4b1b-a546-955724d5bedf) | ![user](https://github.com/xterm-inator/MikroGuard/assets/7698065/4864029e-c176-4577-96f1-20bf3e982b53) | ![connection](https://github.com/xterm-inator/MikroGuard/assets/7698065/1f44b3b7-f4c6-4bd1-819a-b1e19fdf619c)
@@ -102,15 +102,15 @@ docker run -d
 -e ROUTEROS_WIREGUARD_INTERFACE='wireguard' #wireguard interface name 
 -e ROUTEROS_WIREGUARD_ENDPOINT='192.168.0.1:13231' #ip:port for wireguard interface
 -e APP_URL='https://my.public.address'
-ghcr.io/xterm-inator/MikroGuard:latest
+ghcr.io/xterm-inator/mikroguard:latest
 ````
 
 **Docker Compose**:
 ```yml
 version: '3.8'
 services:
   MikroGuard:
-    image: ghcr.io/xterm-inator/MikroGuard:latest
+    image: ghcr.io/xterm-inator/mikroguard:latest
     container_name: MikroGuard
     restart: always
     ports:

diff --git a/api/config/app.php b/api/config/app.php
@@ -15,7 +15,7 @@
     |
     */
 
-    'name' => env('APP_NAME', 'MicroGuard'),
+    'name' => env('APP_NAME', 'MikroGuard'),
 
     /*
     |--------------------------------------------------------------------------

diff --git a/api/config/session.php b/api/config/session.php
@@ -130,7 +130,7 @@
 
     'cookie' => env(
         'SESSION_COOKIE',
-        Str::slug(env('APP_NAME', 'microguard'), '_').'_session'
+        Str::slug(env('APP_NAME', 'MikroGuard'), '_').'_session'
     ),
 
     /*

diff --git a/frontend/index.html b/frontend/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8" />
     <link rel="icon" href="/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MicroGuard</title>
+    <title>MikroGuard</title>
   </head>
   <body>
     <div id="app"></div>

diff --git a/frontend/src/templates/Main.vue b/frontend/src/templates/Main.vue
@@ -6,7 +6,7 @@
           <span class="navbar-toggler-icon"></span>
         </button>
         <a class="navbar-brand navbar-brand-autodark d-none-navbar-horizontal pe-0 pe-md-3">
-          MicroGuard
+          MikroGuard
         </a>
 
         <div class="navbar-nav flex-row order-md-last">
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,7 +15,7 @@ @@
         |
         */
-        'name' => env('APP_NAME', 'MicroGuard'),
+        'name' => env('APP_NAME', 'MikroGuard'),
         /*
         |--------------------------------------------------------------------------
@@ Expand Down @@