README
¶
upbrr
Alpha release: upbrr is early software and the documentation is incomplete. It is intended for users who already understand Upload Assistant workflows, tracker rules, release naming, category/type selection, screenshots, descriptions, torrent clients, and post-upload checking.
Quality check every upload before submitting. Pay close attention to generated names, tracker category, tracker type, edition/source/resolution handling, description output, image links, and torrent-client injection settings. Do not rely on alpha automation as the final authority.
upbrr is a guided upload preparation app for private-tracker workflows. It helps you prepare, review, and submit releases without replacing tracker rules or user judgement.
Features
- metadata lookup and release-name preparation
- tracker selection and duplicate checks
- screenshot generation, selection, and image hosting
- tracker descriptions and upload previews
- tracker submission and torrent-client integration
- Web UI and CLI workflows
- Upload Assistant configuration migration
Documentation
Start with the installation guide and quick start.
- Introduction
- Migration from Upload Assistant
- Configuration
- CLI
- Web UI
- Upload workflow
- Trackers
- Troubleshooting
Community and Support
License
GPL-2.0-or-later. See LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
architecturepolicy
command
|
|
|
commitmsgcheck
command
|
|
|
gofixchanged
command
|
|
|
literalpolicy
command
|
|
|
logpolicy
command
|
|
|
pathpolicy
command
|
|
|
upbrr
command
|
|
|
workflowcontractgen
command
Command workflowcontractgen generates the release-workflow OpenAPI document and its WebUI transport types from pkg/api DTOs plus the public route manifest.
|
Command workflowcontractgen generates the release-workflow OpenAPI document and its WebUI transport types from pkg/api DTOs plus the public route manifest. |
|
internal
|
|
|
apitoken
Package apitoken owns persistent bearer-token generation, validation, and authentication.
|
Package apitoken owns persistent bearer-token generation, validation, and authentication. |
|
architecturepolicy
Package architecturepolicy enforces lasting ownership boundaries for the canonical runtime and prepared-release architecture.
|
Package architecturepolicy enforces lasting ownership boundaries for the canonical runtime and prepared-release architecture. |
|
authmaterial/authfixture
Package authfixture writes web-auth material for tests that exercise encrypted persistence without exercising password hashing.
|
Package authfixture writes web-auth material for tests that exercise encrypted persistence without exercising password hashing. |
|
bbcode
Package bbcode provides shared BBCode cleanup and normalization primitives.
|
Package bbcode provides shared BBCode cleanup and normalization primitives. |
|
clientdiscovery
Package clientdiscovery owns normalized, source-scoped torrent-client discovery for canonical preparation.
|
Package clientdiscovery owns normalized, source-scoped torrent-client discovery for canonical preparation. |
|
config/importer
Package importer dispatches configuration imports to the appropriate parser based on file extension.
|
Package importer dispatches configuration imports to the appropriate parser based on file extension. |
|
configstore
Package configstore bridges the config package and the sqlite repository so CLI and WebUI share a single implementation of the open-database → migrate → load/save flow that used to be duplicated across cmd/upbrr/main.go and internal/webserver runtime activation.
|
Package configstore bridges the config package and the sqlite repository so CLI and WebUI share a single implementation of the open-database → migrate → load/save flow that used to be duplicated across cmd/upbrr/main.go and internal/webserver runtime activation. |
|
description/unit3d
Package unit3d builds and cleans descriptions shared by Unit3D trackers.
|
Package unit3d builds and cleans descriptions shared by Unit3D trackers. |
|
dvdvideo/engine
Package engine coordinates bounded DVD menu inventory, navigation-state discovery, exact FFmpeg background decoding, and Go subpicture composition.
|
Package engine coordinates bounded DVD menu inventory, navigation-state discovery, exact FFmpeg background decoding, and Go subpicture composition. |
|
dvdvideo/graph
Package graph performs deterministic, bounded DVD menu discovery over cloned pure-Go VM state and reconciles reachable results with the IFO inventory.
|
Package graph performs deterministic, bounded DVD menu discovery over cloned pure-Go VM state and reconciles reachable results with the IFO inventory. |
|
dvdvideo/ifo
Package ifo parses the bounded DVD-Video menu structures needed for menu inventory and VM traversal.
|
Package ifo parses the bounded DVD-Video menu structures needed for menu inventory and VM traversal. |
|
dvdvideo/nav
Package nav parses DVD-Video NAV PCI/DSI packets and routes DVD subpicture private-stream payloads.
|
Package nav parses DVD-Video NAV PCI/DSI packets and routes DVD subpicture private-stream payloads. |
|
dvdvideo/render
Package render probes FFmpeg DVD menu capability and decodes exact-coordinate menu background frames selected by the pure-Go engine.
|
Package render probes FFmpeg DVD menu capability and decodes exact-coordinate menu background frames selected by the pure-Go engine. |
|
dvdvideo/spu
Package spu reassembles, decodes, and composites DVD subpicture packets.
|
Package spu reassembles, decodes, and composites DVD subpicture packets. |
|
dvdvideo/vm
Package vm decodes and executes DVD-Video virtual-machine commands.
|
Package vm decodes and executes DVD-Video virtual-machine commands. |
|
errors
Package errors defines sentinel failure classes shared across internal package boundaries.
|
Package errors defines sentinel failure classes shared across internal package boundaries. |
|
externalidentity
Package externalidentity resolves one canonical, source-scoped external identity without persisting it.
|
Package externalidentity resolves one canonical, source-scoped external identity without persisting it. |
|
imagehosting
Package imagehosting selects, uploads, and persists release images.
|
Package imagehosting selects, uploads, and persists release images. |
|
imagehosting/policy
Package policy describes generic image uploader capabilities.
|
Package policy describes generic image uploader capabilities. |
|
literalpolicy
Package literalpolicy enforces readable layout for substantial keyed composite literals.
|
Package literalpolicy enforces readable layout for substantial keyed composite literals. |
|
pathing
Package pathing provides portable host-filesystem path operations.
|
Package pathing provides portable host-filesystem path operations. |
|
pathing/layout
Package layout defines deterministic application filesystem layouts.
|
Package layout defines deterministic application filesystem layouts. |
|
pathing/policy
Package policy checks repository source for portable path-handling violations.
|
Package policy checks repository source for portable path-handling violations. |
|
preparedrelease
Package preparedrelease owns immutable, source-scoped prepared-release generations and their private preparation resources.
|
Package preparedrelease owns immutable, source-scoped prepared-release generations and their private preparation resources. |
|
preparedrelease/state
Package preparationstate contains mutable evidence while a prepared release is being collected.
|
Package preparationstate contains mutable evidence while a prepared release is being collected. |
|
providerid
Package providerid formats canonical numeric provider identifiers for external text contracts.
|
Package providerid formats canonical numeric provider identifiers for external text contracts. |
|
releasepolicy
Package releasepolicy applies release-wide upload eligibility rules.
|
Package releasepolicy applies release-wide upload eligibility rules. |
|
releaseworkflow
Package releaseworkflow coordinates immutable release workflow stages and keeps repository and private-resource concerns behind one command boundary.
|
Package releaseworkflow coordinates immutable release workflow stages and keeps repository and private-resource concerns behind one command boundary. |
|
services/db/dbfixture
Package dbfixture provides SQLite fixtures for integration tests outside the db package.
|
Package dbfixture provides SQLite fixtures for integration tests outside the db package. |
|
services/dvdmenus
Package dvdmenus captures, persists, lists, and deletes managed DVD menu screenshots while preserving manual and normal screenshot categories.
|
Package dvdmenus captures, persists, lists, and deletes managed DVD menu screenshots while preserving manual and normal screenshot categories. |
|
sourcelayout
Package sourcelayout resolves one requested preparation source into the local resource roots used while collecting release facts.
|
Package sourcelayout resolves one requested preparation source into the local resource roots used while collecting release facts. |
|
torrent
Package torrent validates reusable torrent metadata or creates private torrent artifacts for prepared source layouts.
|
Package torrent validates reusable torrent metadata or creates private torrent artifacts for prepared source layouts. |
|
torrent/metainfo
Package metainfo defines application-owned torrent metainfo values.
|
Package metainfo defines application-owned torrent metainfo values. |
|
torrentclient
Package torrentclient injects uploads into configured torrent clients and searches those clients for already-pathed torrents.
|
Package torrentclient injects uploads into configured torrent clients and searches those clients for already-pathed torrents. |
|
trackers/auth
Package auth manages tracker login, cookie import, session validation, and encrypted auxiliary auth state for tracker implementations.
|
Package auth manages tracker login, cookie import, session validation, and encrypted auxiliary auth state for tracker implementations. |
|
trackers/auth/contract
Package contract provides dependency-safe tracker auth capability and requirements constructors.
|
Package contract provides dependency-safe tracker auth capability and requirements constructors. |
|
trackers/auth/totp
Package totp generates tracker-compatible one-time codes from OTP URIs.
|
Package totp generates tracker-compatible one-time codes from OTP URIs. |
|
trackers/data
Package data coordinates metadata lookups owned by tracker implementations.
|
Package data coordinates metadata lookups owned by tracker implementations. |
|
trackers/dupe
Package dupe coordinates tracker-owned duplicate searches and shared matching.
|
Package dupe coordinates tracker-owned duplicate searches and shared matching. |
|
trackers/impl/standalone
Package standalone owns shared lifecycle and definition behavior for tracker implementations that do not belong to a protocol family.
|
Package standalone owns shared lifecycle and definition behavior for tracker implementations that do not belong to a protocol family. |
|
trackers/impl/standalone/czt
Package czt implements uploads to CZTeam (CZT) via its dedicated JSON endpoint takeupload_api.php.
|
Package czt implements uploads to CZTeam (CZT) via its dedicated JSON endpoint takeupload_api.php. |
|
trackers/impl/standalone/internal/jsondupe
Package jsondupe executes the authenticated JSON-list search protocol shared by standalone trackers while leaving query and result identity tracker-local.
|
Package jsondupe executes the authenticated JSON-list search protocol shared by standalone trackers while leaving query and result identity tracker-local. |
|
trackers/impl/unit3d
Package unit3d provides Unit3D API-based tracker upload implementations.
|
Package unit3d provides Unit3D API-based tracker upload implementations. |
|
uploadinput
Package uploadinput resolves transport-local composite upload inputs.
|
Package uploadinput resolves transport-local composite upload inputs. |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.