Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Shows a "Sponsor" button on the repository. The crypto wallet addresses are
# listed in the README's "Support the project" section.
custom:
- https://nowpayments.io/donation/iitzSeriZ
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## What this changes

<!-- What does this pull request do, and why? Link the issue it addresses, if any. -->

## How it was checked

<!-- Tick what applies and delete the rest. -->

- [ ] `npm test` passes (needs Go 1.22+; it renders the fixture pages first)
- [ ] `npm run verify` passes
- [ ] `npm run build` was run and `template/index.html` is committed, if anything under `src/` changed
- [ ] `npm run lint:sh` passes, if a shell script changed
- [ ] `cd docs && npm ci && npm run build` passes, if anything under `docs/` changed

## Before you submit

- [ ] No secrets anywhere: no subscription URLs, `subId` values, UUIDs, panel credentials, cookies, tokens, keys or real server addresses, in code, fixtures, tests, screenshots or commit messages
- [ ] User-facing changes are noted under the unreleased version in `CHANGELOG.md`
- [ ] If the README changed, the translated READMEs keep the same commands, paths, URLs and wallet addresses
72 changes: 72 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Build the documentation site in docs/ and publish it to GitHub Pages.
#
# Pull requests that touch docs/ are built but never deployed. A push to main
# that touches docs/, or a manual run on main, builds and deploys.
#
# One-time repository setup: Settings -> Pages -> Build and deployment ->
# Source: "GitHub Actions".

name: Docs

on:
push:
branches: [main]
paths:
- "docs/**"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- ".github/workflows/docs.yml"
workflow_dispatch:

permissions:
contents: read

# One deployment at a time; a newer push supersedes a queued one, but a
# deployment already running is allowed to finish.
concurrency:
group: pages-${{ github.ref }}
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version-file: docs/.nvmrc
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install (lockfile only)
run: npm ci

- name: Build
run: npm run build

- name: Upload the site
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: docs/dist

deploy:
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
82 changes: 82 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,87 @@ All notable changes to this project are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.2.0] - Unreleased

Turns Row-Template from one page into a collection of designs. A minor release:
Row stays the default design, and 3X-UI (>= 3.6.0) stays the only supported
panel.

### Added

- **Fifteen designs.** Row plus Editorial, Canvas, Prism, Terminal, Pulse,
Brutal, Arcade, Sketch, Signature, Saffron, Pulse Nova, Prism Nova, Terminal
Nova, and Arcade Nova. Every design is built from the same runtime and
translations, so status, Connect, QR codes, the Configuration Explorer, and
the five languages behave the same in each.
- **Choosing a design.** A fresh interactive install shows a design chooser
(Enter keeps Row). `RT_TEMPLATE=<id>` picks one for a scripted install, and
the manager's **Reconfigure branding → Template** changes it later. Updates
keep the selected design.
- **Checksummed designs.** Each design ships in the release with its own
SHA-256 checksum. `row-template verify` checks every installed design against
its checksum and confirms the live page is the selected design.
- **Painted country flags.** The flags of Germany, France, the Netherlands,
Japan, Sweden, and the United States are drawn with CSS, so they appear on
Windows in Chromium-based browsers, which otherwise show the two letters
(`DE`) instead of a flag. Other countries keep the platform's flag emoji.
- **Documentation site** in English, Persian, and Arabic: installation,
configuration, a template gallery with real previews, branding, security,
compatibility, a developer reference, and troubleshooting.
- **Panel shells for research.** The release carries each design's page shell
for every panel in the registry under `shells/`: 3X-UI, PasarGuard (Jinja2)
and Rebecca (pongo2). The installer does not place these files. PasarGuard
and Rebecca are research targets, not supported panels, and there are no
installation instructions for them.

### Changed

- **Panel database detection fails closed.** Row-Template previously used the
first `x-ui.db` it found. It now uses the first database file that exists —
the one `XUI_DB_FOLDER` names, then the default locations in order — and
only if it is a real SQLite database. If that file is not, it is refused with
a warning instead of silently moving on to another, possibly stale, database;
activation then falls back to the manual instructions.
- **Live refresh accepts only its own data.** The status refresh now checks
that a response carries the page's own fields before using it. An
unexpected response stops the refresh and leaves the server-rendered figures
in place, instead of repainting the page with wrong values.
- The country-code table is stored as a bitmap, saving about 800 bytes in
every page.

### Internal

- Groundwork for installing on more than one panel: a normalized data
contract, build-time adapters for 3X-UI, PasarGuard and Rebecca, a frozen
panel interface, a transaction engine, a 3X-UI panel adapter, and a
format-2 backup snapshot. No `row-template` command calls any of it yet;
backups and rollback still use the 1.1.0 format.
- The release ships the management library's companion files
(`lib/transaction.sh` and `panels/`), and install and update put them next
to the library. A payload whose library is present without them is refused
before anything changes.

### Development

- `npm test` first renders every design's fixture pages (`npm run
fixtures:all`), so a fresh clone can run the suite; it needs Go 1.22 or
newer.
- `npm run lint:sh` runs ShellCheck over every shell script.
- The test harness runs on Linux and on Windows with Git Bash.
- `tools/make-release.sh` is executable, as its usage line documents.
- Design records moved from the repository root to
[`docs/design/`](docs/design/README.md), with an index.

### Compatibility

- Requires 3X-UI (MHSanaei) **>= 3.6.0**.
- **Updating from 1.1.0 takes two runs of `row-template update`.** The first
is carried out by 1.1.0's own updater: it installs the new version — the
page updates and your branding is kept — but copies only the library and
the command, so only Row is available. The second, carried out by 1.2.0,
installs every design and the remaining installer files. `row-template
verify` reports whether the second run is still needed.

## [1.1.0] - 2026-08-30

Evolves the subscriber page into a connection and configuration hub. A minor,
Expand Down Expand Up @@ -81,5 +162,6 @@ First stable release.
- Requires 3X-UI (MHSanaei) **>= 3.6.0**; validated against stock 3.7.0.
- Recommended operating system: Ubuntu 24.04 LTS (x86_64).

[1.2.0]: https://github.com/iitzSeriZdev/Row-Template/compare/v1.1.0...main
[1.1.0]: https://github.com/iitzSeriZdev/Row-Template/releases/tag/v1.1.0
[1.0.0]: https://github.com/iitzSeriZdev/Row-Template/releases/tag/v1.0.0
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement. On GitHub, use
**Report content** from the "..." menu of the issue, pull request, or comment
concerned, and choose to report it to the repository's maintainers. All
complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading
Loading