From d84f1a93bf29c817e41b05459477bed32585f95d Mon Sep 17 00:00:00 2001 From: admin Date: Thu, 23 Apr 2026 06:48:33 +0000 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 176 +++++++++++++++++++++++++++--------------------------- 1 file changed, 88 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 5e04d9a..6ba635c 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,88 @@ -# RemnaWave VPN Panel (Go) - -MVP panel on Go with: -- main page -- registration -- authorization -- personal cabinet -- VPN config purchase via real external API and permanent key - -## One-click install/uninstall/reinstall (Ubuntu) - -Requirements: -- Docker Engine + Docker Compose plugin installed -- `bash` available (default on Ubuntu) - -First setup: -1. Copy `.env.example` to `.env` -2. Fill real values in `.env`: - - `API_BASE_URL` - - `API_BUY_PATH` - - `API_KEY` - -Make scripts executable once: - -```bash -chmod +x install.sh uninstall.sh reinstall.sh -``` - -One-click commands: - -```bash -./install.sh -./uninstall.sh -./reinstall.sh -``` - -- `install.sh` - build and start panel -- `uninstall.sh` - stop and remove container(s) -- `reinstall.sh` - full restart with rebuild - -After install: `http://localhost:8080` - -## Run locally without Docker - -1. Copy env file: - - `.env.example` -> `.env` -2. Set real values: - - `API_BASE_URL` - - `API_BUY_PATH` - - `API_KEY` -3. Start: - -```bash -go run . -``` - -Open: `http://localhost:8080` - -## Run in Docker Compose manually - -```bash -docker compose up --build -``` - -## External API contract expected - -POST `${API_BASE_URL}${API_BUY_PATH}` - -Headers: -- `Authorization: Bearer ` -- `Content-Type: application/json` - -Request JSON: - -```json -{ - "email": "user@example.com", - "plan": "monthly" -} -``` - -Response JSON: - -```json -{ - "config": "vpn://...." -} -``` +# RemnaWave VPN Panel (Go) + +MVP panel on Go with: +- main page +- registration +- authorization +- personal cabinet +- VPN config purchase via real external API and permanent key + +## One-click install/uninstall/reinstall (Ubuntu) + +Requirements: +- Docker Engine + Docker Compose plugin installed +- `bash` available (default on Ubuntu) + +First setup: +1. Copy `.env.example` to `.env` +2. Fill real values in `.env`: + - `API_BASE_URL` + - `API_BUY_PATH` + - `API_KEY` + +Make scripts executable once: + +```bash +chmod +x install.sh uninstall.sh reinstall.sh +``` + +One-click commands: + +```bash +./install.sh +./uninstall.sh +./reinstall.sh +``` + +- `install.sh` - build and start panel +- `uninstall.sh` - stop and remove container(s) +- `reinstall.sh` - full restart with rebuild + +After install: `http://localhost:3050` + +## Run locally without Docker + +1. Copy env file: + - `.env.example` -> `.env` +2. Set real values: + - `API_BASE_URL` + - `API_BUY_PATH` + - `API_KEY` +3. Start: + +```bash +go run . +``` + +Open: `http://localhost:8080` + +## Run in Docker Compose manually + +```bash +docker compose up --build +``` + +## External API contract expected + +POST `${API_BASE_URL}${API_BUY_PATH}` + +Headers: +- `Authorization: Bearer ` +- `Content-Type: application/json` + +Request JSON: + +```json +{ + "email": "user@example.com", + "plan": "monthly" +} +``` + +Response JSON: + +```json +{ + "config": "vpn://...." +} +```