Skip to content

techgarage-ir/MTWireGuard

Repository files navigation


GitHub Stars GitHub Issues Current Version

Logo

MTWireguard

An awesome way to manage Mikrotik Wireguard interface!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

Donations

If you found this project helpful and want to support its development, consider making a donation:

  • BTC BTC: bc1qdpplplhmw5fmk66czm0ew9rg4eev98u9gall2w
  • USDT USDT (TRC20): TX4uYnWSjmVAYGB2zoBZq95a9Q4RX9mRhS
  • SOL SOL: 3hwQaAUVsA1fviC2cDD7cpMCzoj1P8kuhnZNA4FKuS2g
  • TON TON: UQAJFLfAV-bNc_kIoVbV6w447z__vzJFTFrW30Q04QCGvV9d

Your support helps maintain and improve this project. Thank you!

About The Project

MTWireguard screenshot

This is the first and most Stable and Secure Accounting system built to manage Wireguard interface on Mikrotik (CHR and devices). You can easily make a Virtual Private Network based on Wireguard protocol in your RouterOS device.

Here's why:

  • Ability to install on RouterOS itself (using Docker)
  • Compatible with future RouterOS updates
  • Storing all your data on your own server

Disclaimer: This project is only for education. Do not use it for illegal purposes.
Any illegal usage of this software is solely the responsibility of the user. The creators and contributors of this project aren't liable for any misuse or damages caused by improper usage of this software.

(back to top)

Built With

This project is built using the following frameworks/libraries.

  • DotNet
  • GitHub Actions
  • SQLite
  • Docker
  • SwaggerUI
  • Bootstrap
  • JQuery

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Requirements to install MTWireguard on a RouterOS system (recommended).

  • Mikrotik device or CHR running RouterOS
  • A minimum of 2GB Ram
  • A minimum of 5GB Disk

Installation

As of this project is based on docker, you can install on any OS that can run docker containers such as Linux, Windows or RouterOS itself.

Method 1 (recommended)

Install on RouterOS

Method 2

Installing on VPS using docker

(back to top)

Usage

For examples, please refer to the Documentation

(back to top)

Roadmap

  • Add traffic-usage limit
  • Add expiration date
  • Add auto addressing (via /ip/pool)
  • Add auto build via github-actions
  • Add "comments" on peers
  • Add backup-restore configuration
  • Add bandwidth limit

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Telegram Channel

Telegram Group

(back to top)