FRP Manager

Contributing to FRP Manager

Thank you for your interest! Bug reports, ideas, translations and pull requests are welcome, in English or French. By taking part, you agree to the code of conduct.

Reporting a bug or suggesting an idea

  • Search the existing issues first.
  • Use the "Bug" or "Feature request" template: panel version, install method (script or Docker), frp version, steps to reproduce.
  • Remove tokens, public IP addresses and domain names from what you paste (TOML configurations, logs).
  • Security issues are not reported in a public issue: see SECURITY.md.

Setting up the environment

The panel is a Go program (panel/*.go, Go 1.26 or later) that embeds its interface at build time: native ES modules in the browser (panel/templates/assets/js/), with no build step.

git clone https://github.com/Gogowwww/frp-manager.git && cd frp-manager
go build -o frp-manager ./panel

To run the panel locally without touching /etc/frp-manager:

echo '{"bind_port": 18765, "ssl_enabled": false}' > /tmp/frpm.json
FRP_MANAGER_CONFIG=/tmp/frpm.json go run ./panel

The README and the community files (.github/: SECURITY, CONTRIBUTING, CODE_OF_CONDUCT) are in this repository. The installation guide, the changelogs and the French translations of the community files live in the website's private repository, which builds and publishes frp-manager.org (the website is never edited directly). The live demo is built from panel/templates/.

Before opening a pull request

go vet ./... && go test ./... && gofmt -l .
python3 -m py_compile packaging/python-bridge/app.py   # Python bridge
  • One pull request = one topic. Describe the problem it solves and how you tested it (install script, Docker, or both).
  • Keep the style of the existing code: explicit names, no new dependency without a reason. A new or changed comment is written in French (with proper accents), then in English right below it; so is a commit message: title "français / English", body in French then in English.
  • Add a test when you touch authentication, input validation or system commands.
  • System commands are always argument lists (exec.Command, never sh -c with interpolated data); every service or container name goes through validServiceName / validContainerName.
  • The interface only builds the DOM with h() (panel/templates/assets/js/ui.js), never with innerHTML on data. No emoji in the interface: icons are the embedded SVGs of panel/templates/partials/icons.html.
  • The maintainer records the change in the "Unreleased" section of the changelogs, in both languages (they live in the website's private repository, see below): contributors do not need to touch them.

Versions and releases

All continuous integration, releases and publishing run on GitHub Actions (.github/workflows/), including the Plumber scan, which only reads .github/workflows and only publishes the README score from GitHub. The apt repository is apt.frp-manager.org, a static repository signed with the APT_GPG_KEY secret and published by publish-pages.sh to the frp-manager-apt Cloudflare Pages project (direct upload with wrangler, CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID secrets). The website is built from a private repository and deployed to Cloudflare Pages; site-notify.yml tells it when the README, .github/ or the interface change.

  • Numbers: up to 0.0.60, versions follow each other (0.0.59, 0.0.60). Then semantic versioning from 0.1.0: the middle number for a new feature (0.2.0), the last one for fixes only (0.1.1), the first one for a change that breaks the configuration, the API or the installation (1.0.0).
  • Pre-release: an annotated vX.Y.Z tag on main (after the dated section of both CHANGELOGs) runs release.yml: program, :X.Y.Z image, packages in the testing apt distribution, GitHub pre-release. Its notes (French then English) come from both CHANGELOGs through tools/releasenotes: the dated section starts with a one-sentence summary, which becomes the title and introduction (go run ./tools/releasenotes vX.Y.Z to proofread them before tagging).
  • Final release: promote.yml (Actions → "Promote", tag vX.Y.Z) makes the same pre-release final, without rebuilding it: what was tried is exactly what gets published (:latest image, stable apt distribution).
  • GitHub protections (Settings → Rules): main and blocklists cannot be deleted or force-pushed, and v* tags cannot be deleted or moved. To redo a tag, turn off the "Tags de version" ruleset first, then turn it back on.

Translating the panel

All interface texts live in panel/templates/assets/locales/: fr.js (reference language) and en.js.

  1. Copy fr.js to <code>.js (de.js, es.js…) and translate the values, without touching the keys or the {parameters}.
  2. Declare the language in LOCALES in panel/templates/assets/js/i18n.js.
  3. While it is incomplete, also add it to PREVIEW_LOCALES: it is offered in Settings marked preview, without being picked from the browser language.

Every key added to fr.js must also be added to en.js (otherwise the interface silently falls back to French). The documentation exists in two languages: X.md in English, X.fr.md in French (README; the installation guide and the changelogs, in the website's repository). SECURITY, CONTRIBUTING and CODE_OF_CONDUCT are in English in this repository.

Community blocklists

A list of addresses to share? Use the Publish button on a Block firewall rule, or open a pull request on the blocklists branch.

License

By contributing, you agree that your contribution is published under the project's license, Apache 2.0.

Edit this page on GitHub