| 1 |
df3ebf4 |
Mrdn |
2y ago |
<h1 align="center"/>Marzneshin</h1> |
| 2 |
a47eb4c |
Dawsh |
2y ago |
|
| 3 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 4 |
bfd37dd |
Mrdn |
2y ago |
A Scalable and Comprehensive Proxy Engine management panel. |
| 5 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 6 |
a47eb4c |
Dawsh |
2y ago |
|
| 7 |
a47eb4c |
Dawsh |
2y ago |
<br/> |
| 8 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 9 |
e0f12ba |
Mardin |
2y ago |
<a href="https://github.com/marzneshin/marzneshin/actions/workflows/dashboard-ci.yml"> |
| 10 |
e0f12ba |
Mardin |
2y ago |
<img src="https://github.com/marzneshin/marzneshin/actions/workflows/dashboard-ci.yml/badge.svg" /> |
| 11 |
91055d4 |
Mrdn |
2y ago |
</a> |
| 12 |
e0f12ba |
Mardin |
2y ago |
<a href="https://github.com/marzneshin/marzneshin/actions/workflows/package.yml" target="_blank"> |
| 13 |
e0f12ba |
Mardin |
2y ago |
<img src="https://github.com/marzneshin/marzneshin/actions/workflows/package.yml/badge.svg" /> |
| 14 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 15 |
953c697 |
Dawsh |
2y ago |
<a href="https://hub.docker.com/r/dawsh/marzneshin" target="_blank"> |
| 16 |
bf00248 |
Dawsh |
2y ago |
<img src="https://img.shields.io/docker/pulls/dawsh/marzneshin?style=flat-square&logo=docker" /> |
| 17 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 18 |
91055d4 |
Mrdn |
2y ago |
<br> |
| 19 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 20 |
e0f12ba |
Mardin |
2y ago |
<img src="https://img.shields.io/github/license/marzneshin/marzneshin?style=flat-square" /> |
| 21 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 22 |
bf00248 |
Dawsh |
2y ago |
<a href="https://t.me/marzneshins" target="_blank"> |
| 23 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" /> |
| 24 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 25 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 26 |
a47eb4c |
Dawsh |
2y ago |
<img src="https://img.shields.io/badge/twitter-commiunity-blue?style=flat-square&logo=twitter" /> |
| 27 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 28 |
a47eb4c |
Dawsh |
2y ago |
<a href="#"> |
| 29 |
e0f12ba |
Mardin |
2y ago |
<img src="https://img.shields.io/github/stars/marzneshin/marzneshin?style=social" /> |
| 30 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 31 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 32 |
a47eb4c |
Dawsh |
2y ago |
|
| 33 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 34 |
e0f12ba |
Mardin |
2y ago |
<a href="https://github.com/marzneshin/marzneshin" target="_blank" rel="noopener noreferrer" > |
| 35 |
e0f12ba |
Mardin |
2y ago |
<img src="https://github.com/marzneshin/marzneshin/raw/master/docs/assets/Desktop-full.png" alt="screenshots" width="600" height="auto"> |
| 36 |
a47eb4c |
Dawsh |
2y ago |
</a> |
| 37 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 38 |
a47eb4c |
Dawsh |
2y ago |
|
| 39 |
a47eb4c |
Dawsh |
2y ago |
## Table of Contents |
| 40 |
a47eb4c |
Dawsh |
2y ago |
|
| 41 |
a47eb4c |
Dawsh |
2y ago |
- [Overview](#overview) |
| 42 |
aceb825 |
Mardin |
2y ago |
- [Docs](#docs) |
| 43 |
aceb825 |
Mardin |
2y ago |
- [Features](#features) |
| 44 |
aceb825 |
Mardin |
2y ago |
- [Supported Languages](#supported-languages) |
| 45 |
ece2ed6 |
Dawsh |
2y ago |
- [Marznode](#marznode) |
| 46 |
a47eb4c |
Dawsh |
2y ago |
- [Donation](#donation) |
| 47 |
a47eb4c |
Dawsh |
2y ago |
- [License](#license) |
| 48 |
a47eb4c |
Dawsh |
2y ago |
- [Contributors](#contributors) |
| 49 |
a47eb4c |
Dawsh |
2y ago |
|
| 50 |
a47eb4c |
Dawsh |
2y ago |
# Overview |
| 51 |
a47eb4c |
Dawsh |
2y ago |
|
| 52 |
bfd37dd |
Mrdn |
2y ago |
Marzneshin is a censorship circumvention tool utilizing other censorship circumvention tools. |
| 53 |
a47eb4c |
Dawsh |
2y ago |
|
| 54 |
e0f12ba |
Mardin |
2y ago |
Marzneshin controls the [Marznodes](https://github.com/marzneshin/marznode) |
| 55 |
bfd37dd |
Mrdn |
2y ago |
connected to it; monitoring/disabling/enabling users on marznode instances while |
| 56 |
bfd37dd |
Mrdn |
2y ago |
marznode manages and interacts with vpn backends (such as xray). |
| 57 |
a47eb4c |
Dawsh |
2y ago |
|
| 58 |
aceb825 |
Mardin |
2y ago |
### Docs |
| 59 |
aceb825 |
Mardin |
2y ago |
|
| 60 |
26124b3 |
Dawsh |
2y ago |
Marzneshin documentation may be found [here](https://docs.marzneshin.org). |
| 61 |
aceb825 |
Mardin |
2y ago |
|
| 62 |
bfd37dd |
Mrdn |
2y ago |
### Features |
| 63 |
bfd37dd |
Mrdn |
2y ago |
|
| 64 |
5c78ce8 |
Dawsh |
2y ago |
- **Web UI** Dashboard |
| 65 |
bfd37dd |
Mrdn |
2y ago |
- **Multi Nodes** support for traffic distribution, scalability, and fault tolerance |
| 66 |
bfd37dd |
Mrdn |
2y ago |
- Supports protocols **Vmess**, **VLESS**, **Trojan** and **Shadowsocks** as provided by xray |
| 67 |
a47eb4c |
Dawsh |
2y ago |
- **Multi-protocol** for a single user |
| 68 |
cc2c4b7 |
Mardin |
2y ago |
- Manage users' access to inbounds separately using **services** |
| 69 |
a47eb4c |
Dawsh |
2y ago |
- **Multi-user** on a single inbound |
| 70 |
bfd37dd |
Mrdn |
2y ago |
- Limit users' data and set exire dates |
| 71 |
cc2c4b7 |
Mardin |
2y ago |
- Reset traffic periodically (daily, weekly,...) |
| 72 |
bfd37dd |
Mrdn |
2y ago |
- **Subscription link** compatible with **V2ray** (e.g. V2RayNG, OneClick, Nekoray, etc.), **Clash** and **ClashMeta** |
| 73 |
a47eb4c |
Dawsh |
2y ago |
- Automated **Share link** and **QRcode** generator |
| 74 |
5c78ce8 |
Dawsh |
2y ago |
- System, nodes, traffic statistics, users monitoring |
| 75 |
a47eb4c |
Dawsh |
2y ago |
- Integrated **Command Line Interface (CLI)** |
| 76 |
e0f12ba |
Mardin |
2y ago |
- [**Multi-admin** support](https://github.com/marzneshin/marzneshin/issues/73) (WIP) |
| 77 |
bfd37dd |
Mrdn |
2y ago |
- Marzneshin is decoupled from VPN backends |
| 78 |
bfd37dd |
Mrdn |
2y ago |
- Resilient and fault tolerant node management |
| 79 |
a47eb4c |
Dawsh |
2y ago |
|
| 80 |
cc2c4b7 |
Mardin |
2y ago |
**Deployment and Developer Kit:** |
| 81 |
5c78ce8 |
Dawsh |
2y ago |
|
| 82 |
bfd37dd |
Mrdn |
2y ago |
- REST-full API |
| 83 |
bfd37dd |
Mrdn |
2y ago |
- Kubernetes and multiple deployment strategy and options (WIP) |
| 84 |
bfd37dd |
Mrdn |
2y ago |
|
| 85 |
bfd37dd |
Mrdn |
2y ago |
### Supported Languages |
| 86 |
5c78ce8 |
Dawsh |
2y ago |
|
| 87 |
bfd37dd |
Mrdn |
2y ago |
- Russian (WIP) |
| 88 |
5c78ce8 |
Dawsh |
2y ago |
- English |
| 89 |
bfd37dd |
Mrdn |
2y ago |
- Kurdish (Soranî, Kurmancî) |
| 90 |
cc2c4b7 |
Mardin |
2y ago |
- Persian |
| 91 |
bf00248 |
Dawsh |
2y ago |
|
| 92 |
bf00248 |
Dawsh |
2y ago |
# marznode |
| 93 |
a47eb4c |
Dawsh |
2y ago |
|
| 94 |
e0f12ba |
Mardin |
2y ago |
[marznode](https://github.com/marzneshin/marznode) is the backend needed to run proxy servers. |
| 95 |
a47eb4c |
Dawsh |
2y ago |
|
| 96 |
a47eb4c |
Dawsh |
2y ago |
# Donation |
| 97 |
a47eb4c |
Dawsh |
2y ago |
|
| 98 |
5c78ce8 |
Dawsh |
2y ago |
If you found Marzneshin useful and would like to support its development, you can make a donation in one of the |
| 99 |
5c78ce8 |
Dawsh |
2y ago |
following crypto networks: |
| 100 |
bfd37dd |
Mrdn |
2y ago |
|
| 101 |
bfd37dd |
Mrdn |
2y ago |
- Bitcoin network: 13ZDhE5KHGsfjM4A22eLTUgW98WpXhQTuF |
| 102 |
bfd37dd |
Mrdn |
2y ago |
- TRON network (TRC20): TYxFCiRqJ3SiV6rAQAmJUd3DgVmJvEAfz4 |
| 103 |
bfd37dd |
Mrdn |
2y ago |
- TON network: EQB_VYiU73U1_wk-01I_MLg9-hx953VOf9Y36t2Z04WyUapD |
| 104 |
a47eb4c |
Dawsh |
2y ago |
|
| 105 |
bfd37dd |
Mrdn |
2y ago |
Part of the donations would be tipped to contributors, the rest to collaborators. |
| 106 |
a47eb4c |
Dawsh |
2y ago |
|
| 107 |
bfd37dd |
Mrdn |
2y ago |
May developers be rich. |
| 108 |
a47eb4c |
Dawsh |
2y ago |
|
| 109 |
a47eb4c |
Dawsh |
2y ago |
# License |
| 110 |
a47eb4c |
Dawsh |
2y ago |
|
| 111 |
bfd37dd |
Mrdn |
2y ago |
Published under [AGPL-3.0](./LICENSE). |
| 112 |
a47eb4c |
Dawsh |
2y ago |
|
| 113 |
a47eb4c |
Dawsh |
2y ago |
# Contributors |
| 114 |
a47eb4c |
Dawsh |
2y ago |
|
| 115 |
aceb825 |
Mardin |
2y ago |
We ❤️🔥 contributors! If you'd like to contribute, please check out our [Contributing Guidelines](https://docs.marzneshin.org/docs/contribution-guideline) and |
| 116 |
5c78ce8 |
Dawsh |
2y ago |
feel free to submit a pull request or open an issue. We also welcome you to join |
| 117 |
5c78ce8 |
Dawsh |
2y ago |
our [Telegram](https://t.me/marzneshins) group for either support or contributing guidance. |
| 118 |
a47eb4c |
Dawsh |
2y ago |
|
| 119 |
e0f12ba |
Mardin |
2y ago |
Check [open issues](https://github.com/marzneshin/marzneshin/issues) to help the progress of this project. |
| 120 |
a47eb4c |
Dawsh |
2y ago |
|
| 121 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 122 |
bfd37dd |
Mrdn |
2y ago |
Thanks to all contributors who have helped Marzneshin: |
| 123 |
a47eb4c |
Dawsh |
2y ago |
</p> |
| 124 |
bf00248 |
Dawsh |
2y ago |
<p align="center"> |
| 125 |
e0f12ba |
Mardin |
2y ago |
<a href="https://github.com/marzneshin/marzneshin/graphs/contributors"> |
| 126 |
e0f12ba |
Mardin |
2y ago |
<img src="https://contrib.rocks/image?repo=marzneshin/marzneshin" /> |
| 127 |
bf00248 |
Dawsh |
2y ago |
</a> |
| 128 |
bf00248 |
Dawsh |
2y ago |
</p> |
| 129 |
a47eb4c |
Dawsh |
2y ago |
<p align="center"> |
| 130 |
a47eb4c |
Dawsh |
2y ago |
Made with <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a> |
| 131 |
a47eb4c |
Dawsh |
2y ago |
</p> |