MicroGuard

MicroGuard 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.

Features
Requirements
Setup
Usage
Local Development and Testing with Docker Compose
Contributing
License

Features

Client Management: Streamline the creation and management of WireGuard clients on MikroTik routers.
Real-time Monitoring: Access real-time connection statistics and usage insights.
Access Control: Easily grant or revoke access for individual clients.
Google SSO: Secure sign-in using Google's Single Sign-On system.

Requirements

MikroTik router with RouterOS version 7.0 or newer.
Docker for running the MicroGuard server.

Setup

Adding a User to MikroTik for MicroGuard

Using Winbox:

Log in to your MikroTik router using Winbox.
Navigate to the "System" menu and select "Users".
Click on the "Groups" tab.
Click on the "Add New" button to create a new user group.
Enter a name for the group, such as "microguard-group" and click on the "OK" button.
In the "Permissions" tab, select the desired permissions for the group. For MicroGuard, the user group should have read, write, and API access.
Click on the "Apply" button to save the changes.
Click on the "Users" tab.
Enter the user's details, such as their name and password.

Warning: Always input the correct local subnet into the allowed address. If unsure about the configuration, seek expert advice.

In the "Groups" tab, select the "microguard-group" group you just created.
Click on the "Apply" button to save the changes.

Using Command Line:

To set up a new user group and user, input:

This will create a new user group named "microguard-group" with the necessary permissions for MicroGuard.

/user group add name=microguard-group policy=local,read,write,test,api,winbox,password

Enter the following command to create a new user:

Replace "username" with the desired username and "userpassword" with the desired password for the new user.

/user add name=username group=microguard-group password=userpassword

Warning: Ensure correct subnet configuration as highlighted in the Winbox method.

Creating a Road Warrior WireGuard Interface for MicroGuard

Access your MikroTik router via Winbox.
Go to "WireGuard" > "Add".
Label the interface (e.g., "wireguard road warrior") and click Apply.
Document the public key of the freshly created WireGuard server for subsequent use.

Server Installation

Ensure Docker is up and running on your server.
Generate an app key via this generator for use in upcoming commands.
Deploy MicroGuard using:

If you don't want to use google sso remove the google environment variables from the following commands

Docker Command

docker run -d
--name microguard
-p 80:80
-v /path/to/data:/opt/app/storage
-e APP_KEY=
-e GOOGLE_CLIENT_ID=
-e GOOGLE_CLIENT_SECRET=
-e GOOGLE_REDIRECT_URL='https://my.public.address/api/auth/oauth/google/callback'
-e ROUTEROS_HOST='192.168.0.1'
-e ROUTEROS_PORT='8728'
-e ROUTEROS_USER='wireguard'
-e ROUTEROS_PASS='wireguard pass'
-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/microguard:latest

Docker Compose:

version: '3.8'
services:
  microguard:
    image: ghcr.io/xterm-inator/microguard:latest
    container_name: microguard
    restart: always
    ports:
      - 80:80
    volumes:
      - /path/to/data:/opt/app/storage
    environment:
      - APP_KEY=
      - GOOGLE_CLIENT_ID=
      - GOOGLE_CLIENT_SECRET=
      - GOOGLE_REDIRECT_URL=https://my.public.address/api/auth/oauth/google/callback
      - ROUTEROS_HOST=192.168.0.1
      - ROUTEROS_PORT=8728
      - ROUTEROS_USER=wireguard
      - ROUTEROS_PASS=wireguard pass
      - ROUTEROS_WIREGUARD_INTERFACE=wireguard
      - ROUTEROS_WIREGUARD_ENDPOINT=192.168.0.1:13231
      - APP_URL=https://my.public.address

Initial User

To create the initial user run: (replace: admin@xterm.me with your email)

docker compose exec api php artisan app:create-user admin@xterm.me admin

Local Development and Testing with Docker Compose

To facilitate local development and testing, we've incorporated Docker Compose. This allows developers to run the entire MicroGuard stack locally without complex setups.

Prerequisites:

Docker
Docker Compose
Git

Steps:

Clone the Repository: Use Git to clone the MicroGuard repository to your local machine:

git clone git@github.com:xterm-inator/microguard.git
# Navigate into the repository directory:
cd microguard

Set Up Environment Variables: Before starting the services using Docker Compose, you may need to configure some environment variables. Copy the sample environment file and adjust the settings as necessary:
```
cp api/.env.example api/.env
```
Edit the .env file with appropriate values. Make sure to generate and set values for necessary keys.
Build Containers:
```
docker compose build --parallel
```

Install Dependencies: Using docker run there are some dependencies that need to be setup:

docker compose run api composer install
docker compose run api npm i
docker compose run api php artisan key:generate
docker compose run api php artisan migrate
docker compose run vue npm i

Create an Initial User:

docker compose run api php artisan app:create-user admin@email.com admin

Run with Docker Compose: Start the MicroGuard stack using Docker Compose:
```
docker compose up
```
This will build and start all necessary containers. Once done, the MicroGuard interface should be accessible at http://localhost:3000.
Shutdown and Cleanup: When you're done with local development/testing, you can stop the Docker Compose services:
```
docker compose down
```

Contributing

Contribute to MicroGuard by submitting a pull request or issue on GitHub. We welcome bug reports, feature suggestions, and code enhancements from the community.

License

MicroGuard is licensed under the GNU General Public License v3.0. Details are in the LICENSE.md file.

routeros-fans / microguard