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
translations.i18n/<language>.json in the Hiddify-Panel repository. Fix or add them and send a pull request.
Improve this websiteThe pencil button at the top of each page opens it on GitHub. Fix a mistake or add a guide.
Spread the wordTell others about Hiddify, make videos and guides, and answer users’ questions.
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.
/opt/hiddify-manager.
admin_v2, Vue), config templates, certificates and translations. A submodule in services/panel/src.
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) andgenerated/(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
- On GitHub, Fork the repository you changed (the button at the top of the repository page).
- Make a new branch from
dev, commit, and push it to your fork. If you changed both repositories, commit the panel first. -
Write the commit message in the Conventional Commits style, because the changelog is built from it. For example:
-
Open a pull request to the main repository’s
devbranch. Describe the problem, your change and how you tested it, and add pictures for visual changes.