GFW-knocker/Mahsa_Server

Mahsa Server

What is Mahsa Server?

Mahsa Service is a web based application that enables VPN configs providers to submit their configs to be used in the MahsaNG app.

How to run

1. install docker and docker-compose
2. run docker-compose up -d

How to check

• http://localhost (nginx/frontend)
• http://localhost/backend/app/ (django)
• http://localhost/backend/admin/ (django admin)
• http://localhost:9001 (backend supervisord interface)
• http://localhost:6001 (flower - celery task monitoring)

Login - Superuser

• http://localhost/backend/admin/

Monitoring (must be superuser)

• http://localhost/backend/supervisor/ (backend service supervisor status)
• http://localhostbackend/flower/ (flower - celery task monitoring)
• http://localhost/xray/supervisor/ (xray service supervisor status)

How to develop

Frontend

cd frontend
npm install
npm run serve

Backend

cd backend
virtualenv .env --python=python3.9
source .env/bin/activate
pip3 install -r requirements.txt

Django

./manage.py migrate
./manage.py runserver 0.0.0.0:8000
./manage.py createsuperuser  # create a django superuser (for admin login)

Endpoints

• Config

  [POST] /backend/app/config/        # add new config
  [GET] /backend/app/config/<uuid>/  # retrieve created config
  [GET] /backend/app/config/stats/   # configs stats
  [GET] /backend/app/config/hit_me/  # draw 2 new configs
  [GET] /backend/app/config/ip/      # find ip of client (we use this for finding config server ip!)
  

• Report

  [POST] /backend/app/report/        # add a single report
  

Celery

• Worker

  celery -A worker.app worker --loglevel=info
  

• Beat Scheduler

  celery -A worker.app beat --loglevel=info
  

• Flower

  celery -A worker.app flower --loglevel=info
  

Docker Services

• backend: django, celery
• nginx: serves frontend and static files + proxy to backend service via /backend
• xray: container that has link2json and xray installed + a flask webserver
• redis

Tech Stack

• backend
  • django (main backend)
  • flask (xray webserver)
  • celery (running async tasks)
  • supervisor (managing backend processes)
• frontend
  • Vue.js (can be replaced by any frontend framework)
• redis (used for celery)
• sqlite (django database)