Skip to content

How to contribute to this project

Written for Hiddify Manager v14.5

The development steps below follow the project’s own DEVELOPMENT.md and CONTRIBUTING.md. If they differ from this page, those files are right.

Hiddify Manager is free and open source, and its users help build it. You do not need to be a programmer to help.

Ways to help without code

For other help (development, services), email hiddify@gmail.com.

The repositories

Hiddify Manager is built from three repositories. Work on the dev branch in each.

Set up a development server

Work on a Linux server or VM (preferably Ubuntu 24.04 or 26.04), as root. A development machine is a Hiddify server: the code lives where an installed Hiddify lives.

sudo -i
git clone --recurse-submodules -b dev https://github.com/hiddify/Hiddify-Manager.git /opt/hiddify-manager
cd /opt/hiddify-manager
make build
git -C services/panel/src checkout dev

make build installs everything (MySQL, Redis, HAProxy, Xray, the Hiddify core, the panel, …) in place. Then open /opt/hiddify-manager in VS Code (on a remote server, with the Remote - SSH extension). .vscode/launch.json has the run configurations.

Day to day

  • After changing the panel’s Python code, only restart the panel: systemctl restart hiddify-panel
  • The Admin V2 Dev (Flask + Vite) configuration in VS Code runs the panel with the debugger and the admin UI with live reload.
  • After changing a template or settings, click Apply now in the panel or run: make apply
  • data/ (server state) and generated/ (configs the panel builds) are not in git. Never edit or commit them.
  • Tests are in services/panel/tests (pytest). DEVELOPMENT.md shows how to run them.

Send your change

  1. On GitHub, Fork the repository you changed (the button at the top of the repository page).
  2. Make a new branch from dev, commit, and push it to your fork. If you changed both repositories, commit the panel first.
  3. Write the commit message in the Conventional Commits style, because the changelog is built from it. For example:

    fix: show the right expiry date on the user page
    feat: add a Reality SNI scanner
    
  4. Open a pull request to the main repository’s dev branch. Describe the problem, your change and how you tested it, and add pictures for visual changes.

New to git?


Last update: November 20, 2026

Comments