Reference

Contributing

Report a bug, improve a translation, work on Row-Template itself, or improve this documentation site.

Bug reports, translations and documentation fixes are all welcome. Please read CONTRIBUTING.md and follow the Code of Conduct.

Reporting a bug

Open an issue at github.com/iitzSeriZdev/Row-Template/issues and include:

  • row-template version and row-template verify output;
  • your panel (3X-UI, PasarGuard or Rebecca) and its version;
  • the operating system, its version and the CPU architecture;
  • clear steps to reproduce, what you expected and what happened.

Never include secrets — subscription links, subId values, client UUIDs, panel credentials, cookies, tokens, webBasePath, the contents of .env, database URLs, TLS keys or real server addresses. Security problems go through private reporting, not issues.

Working on Row-Template

You need Node.js 22 or newer. To run the tests you also need Go 1.22 or newer and Python 3 with Jinja2 (pip install jinja2), which render the PasarGuard and Rebecca pages with those panels’ real template engines.

git clone https://github.com/iitzSeriZdev/Row-Template
cd Row-Template
npm run build          # regenerate template/index.html from src/
npm run verify         # check the built page against the safety gates
npm test               # render every design's fixture pages, then run every suite
npm run lint:sh        # ShellCheck every shell script
npm run preview        # preview the fixture pages at http://127.0.0.1:8787

The page is built from readable sources in src/; each design lives in src/templates/<id>/. The build is deterministic, and npm run verify rejects any page that loads something remote or carries a forbidden construct.

Improving this site

This documentation lives in its own repository, iitzSeriZdev/Web-Row-Template. Every page has an Edit this page on GitHub link at the bottom.

git clone https://github.com/iitzSeriZdev/Web-Row-Template
cd Web-Row-Template
npm install
npm run dev            # http://localhost:4321/Web-Row-Template/
  • Pages are MDX files in src/content/docs/en/ and src/content/docs/fa/, one per language with the same path.
  • The template catalogue, the screenshots and the live previews are copied from Row-Template, never edited here. To refresh them, render the fixtures in a Row-Template checkout (npm run fixtures:all) and run npm run sync -- ../Row-Template.
  • The same sync records every error and warning the installer can print — the management library, the command, and every companion it declares (the transaction engine and the panel adapters). npm run check fails if one of them is missing from the error reference or if the reference lists one the installer no longer prints — so a new installer message cannot go undocumented.
  • npm run build builds the site and its search index into dist/.

When you change a page, change it in both languages. Every command, path and message must stay exactly as the installer prints it.

Edit this page on GitHubApplies to Row-Template 1.4.0
Esc
↑↓ to navigate↵ to selectEsc to close