You can easily contribute to this project by using the following links to improve the translations:
https://nodejs.org/en/download/current
after installing node you must download and install yarn
npm install --global yarnyarn
yarn dev
yarn build
A panel admin can show users their own build of this page instead of the built-in one: Settings › Customizing User Page › User page URL.
- Fork this repository and change what you like.
- Every push to
mainbuilds the page into thegh-pagesbranch (.github/workflows/main.yml). To build by hand:USER_FRONT_OUT_DIR=dist npx vite build, then publishdist/anywhere. - In the panel, set the user page URL to the folder that holds
index.html, for example:https://github.com/<you>/hiddify-user-front/tree/gh-pages(read from raw.githubusercontent.com; GitHub Pages doesn't have to be on), orhttps://<you>.github.io/hiddify-user-front/, or any other static host.
The panel downloads the files itself (the server is abroad, so a host that is filtered for users still works), caches them for an hour and serves them on the user's own link. Users never connect to GitHub.
| Where | What |
|---|---|
/<proxy_path>/<uuid>/ |
the site's index.html |
/<proxy_path>/<uuid>/user-page/<file> |
the site's other files; <base href> points here, so keep every path in the build relative (Vite base: './') |
window.__HIDDIFY__ |
the object below, set first in <head> |
window.__HIDDIFY__ = {
version: "14.0.5", // panel version
proxy_path: "AbCdEf", // the client proxy path (PROXY PATH)
uuid: "…", // the user's UUID
page_base: "/AbCdEf/<uuid>/", // the user's page
api_base: "/AbCdEf/<uuid>/api/v2/user/", // the user API: me/, mtproxies/, all-configs/, apps/, short/ …
static_base: "/AbCdEf/static/", // the panel's static files (images, fonts)
profile_url: "https://…/<uuid>/#name", // the subscription link for apps
deep_link: "hiddify://import/https://…", // opens it in the Hiddify app
lang: "fa", // the user's language
brand_title: "…", // Settings › Branding title
}The only things a page must use are api_base (or proxy_path + uuid) and relative asset paths; the rest is
for convenience. The user API is described in the panel at /<proxy_path>/<uuid>/api/v2/user/docs (OpenAPI).
Without window.__HIDDIFY__ (the panel's built-in page, npm run dev) this app falls back to its own URL.