Skip to content

Latest commit

 

History

442 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SBXR

SBXR is a root-only V3 proxy product for one Ubuntu Server. Software Lifecycle installs and updates the sbxr executable. Proxy Installation owns the installed proxy journey through a review-first numbered menu.

The source implements setup and removal, subscription enablement and link rotation, Client Identity rotation, managed renewal recording, and recovery. Implementation and automated tests do not establish release acceptance. Use ADR-0016 for the product contract and the current MVP live acceptance procedure for live qualification.

For development, start with the code map. It links entry points, owning modules, tests, and the release harness. Domain terms are defined in CONTEXT.md. The documentation index separates the current MVP procedure from historical acceptance material and research notes.

Supported system

  • Ubuntu Server 24.04; the first V3 proxy journey accepts only amd64
  • Root authority through sudo
  • An interactive UTF-8 terminal
  • curl for the first GitHub HTTPS download

Software Lifecycle owns /usr/local/bin/sbxr and /var/lib/sbxr/installed.json. Confirmed V3 setup creates the Proxy Installation resources recorded in /var/lib/sbxr/proxy-ownership.json; reviewed Complete removal uses that authority to remove the installation. See the Proxy Installation guide for setup, subscription, identity, and removal responsibilities.

Installation

Use the permanent Pasteable Install Command:

curl -fsSL https://github.com/albertloky/SBXR/releases/latest/download/install.sh | sudo bash

The command supports only the fixed host contract above. It authenticates and verifies the complete candidate before it changes either owned path. A current valid installation is a no-op. A higher-sequence local installation is not downgraded. A proved historical full-product executable from v1.0.0 through v1.0.15 is refused unchanged.

Numbered menu

Run the installed product with no arguments:

sudo sbxr

Every screen shows fresh proxy, subscription, and Software Lifecycle status. The same menu lists legal Proxy Installation Actions plus Check, Update, and Recover. Numbers follow the currently legal proxy Actions. Update shows the exact target; Recover shows the proved direction. Only y approves effects. Empty input or n cancels. Changed facts require a fresh review.

Update and recovery safety

The first subscription release supports clean installation only. No incoming update from v3.0.21 or earlier is supported. Use the old release's reviewed Complete removal, finish an interrupted removal through its exact-release route, then install and set up fresh. Expect downtime, new proxy credentials, and new client setup. Installation refuses remaining authority or resources.

Future recurring updates require explicit qualified source support. They preserve Ownership Record bytes, creating provenance, proxy configuration, and both credentials. Before Committed, recovery restores the exact prior release. After Committed, it retains the candidate and finishes Subscription Serving runtime verification before clearing the Update Record. It does not restart sing-box. See Software Lifecycle for the versioned support and transaction contracts.

Releases and qualification

Each release has exactly four public assets:

install.sh
release-index.json
sbxr-linux-amd64.tar.gz
sbxr-linux-arm64.tar.gz

Stable publication requires native automated proof on both architectures and the live packaged Ubuntu Server 24.04 amd64 journeys for the candidate's declared scope, including required outside-network and actual Karing evidence. Each Release Identity gets its own public Acceptance Record.

The current clean-install MVP scope is mvp-live-v1: mvp-install, mvp-subscription, mvp-credentials, mvp-renewal, and mvp-removal. Use the MVP live acceptance procedure. It retains normal artifact trust, outside traffic, trusted HTTPS, and Karing import/refresh. It does not establish incoming-upgrade behavior, natural timer firing, or naturally due client auto-refresh.

The former V4 operator producer, its 25-scenario procedure, and its evidence guides are historical for their named attempts. The producer is retired from the working tree; historical Go readers and validators remain so existing records retain their meaning. Dated reports in docs/acceptance describe individual attempts. The Installer-Updater release-pair procedure is also historical.

v3.1.0 / Release Sequence 83 has an Owner-approved exception with incomplete live VPS and Karing qualification. It applies only to that release.

Historical full-product releases

Releases v1.0.0 through v1.0.15 remain public, immutable, unsupported history. Their final source is preserved by annotated tag archive/full-product-v1.0.15 at commit 14fdf0a3decb6c653f9669438bf40221813b9d7d. They are not installation, update, migration, recovery, compatibility, or qualification inputs for the Installer-Updater.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages