Skip to content

Release v0.4.1 #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
florianjs merged 1 commit into from
Jan 7, 2026
Merged

Release v0.4.1 #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 60 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Deploy Documentation

on:
push:
branches: [main]
paths:
- 'doc/**'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: doc/package-lock.json

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Install dependencies
run: npm ci
working-directory: doc

- name: Build with VitePress
run: npm run build
working-directory: doc

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/.vitepress/dist

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 2 additions & 2 deletions doc/guide/backup-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Backup & Restore

This guide covers backing up your OpenTracker database and restoring it on a new server.
This guide covers backing up your Trackarr database and restoring it on a new server.

## Why Backup?

Expand Down Expand Up @@ -49,7 +49,7 @@ Store a copy of your `.env` file in a secure location (password manager, encrypt

To restore your database on a new VPS:

**1. Install OpenTracker on the new server**
**1. Install Trackarr on the new server**

Run the installer as usual:

Expand Down
6 changes: 3 additions & 3 deletions doc/guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Configuration

OpenTracker is configured primarily through environment variables. This page covers all available options.
Trackarr is configured primarily through environment variables. This page covers all available options.

## Environment Variables

### Core Settings

| Variable | Description | Default |
| ----------------------- | ---------------------------------- | ------------- |
| `NUXT_PUBLIC_SITE_NAME` | Your tracker's display name | `OpenTracker` |
| `NUXT_PUBLIC_SITE_NAME` | Your tracker's display name | `Trackarr` |
| `NUXT_PUBLIC_SITE_URL` | Public URL of your tracker | — |
| `NUXT_SESSION_PASSWORD` | Session encryption key (32+ chars) | — |

Expand Down Expand Up @@ -66,7 +66,7 @@ Replace `your-domain.com` with your actual tracker domain.

The production compose file includes:

- **app** — Main OpenTracker application
- **app** — Main Trackarr application
- **db** — PostgreSQL 16 database
- **redis** — Redis 7 cache
- **caddy** — Reverse proxy with automatic HTTPS
Expand Down
4 changes: 2 additions & 2 deletions doc/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

This guide will help you get OpenTracker up and running in minutes.
This guide will help you get Trackarr up and running in minutes.

## Prerequisites

Expand Down Expand Up @@ -124,7 +124,7 @@ Open `https://your-domain.com` to access your tracker.

## Updating

To update your OpenTracker installation to the latest version:
To update your Trackarr installation to the latest version:

```bash
cd /opt/opentracker
Expand Down
2 changes: 1 addition & 1 deletion doc/guide/load-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Load Testing

OpenTracker includes a built-in load testing suite to measure tracker performance under high concurrency.
Trackarr includes a built-in load testing suite to measure tracker performance under high concurrency.

## Quick Start

Expand Down
22 changes: 14 additions & 8 deletions doc/guide/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Roadmap

OpenTracker is actively developed with a focus on performance, security, and usability. Below is our current development roadmap.
Trackarr is actively developed with a focus on performance, security, and usability. Below is our current development roadmap.

## v0.3.x
## Released

Features implemented, pending public release:
### v0.4.0 — Rebranding to Trackarr

- [x] **Project Rebranding** — Trackarr renamed to Trackarr
- [x] **Repository Migration** — New public repository at `florianjs/trackarr`
- [x] **Documentation Updates** — All references updated to Trackarr

### v0.3.x — Core Features

- [x] **Custom Branding** — Logo, favicon, site name, colors, font weight
- [x] **Invitation System** — Private invite codes with per-user limits
Expand All @@ -18,7 +24,7 @@ Features implemented, pending public release:

---

## v0.4.0 — User Features
## v0.5.0 — User Features

- [ ] **Favorites / Watchlist** — Save torrents to personal list
- [ ] **Freeleech System** — Global and per-torrent freeleech toggle
Expand All @@ -27,7 +33,7 @@ Features implemented, pending public release:

---

## v0.5.0 — Community
## v0.6.0 — Community

- [ ] **Torrent Requests** — Request content with bounty system
- [ ] **Bonus Points** — Reward seeders with exchangeable points
Expand All @@ -36,13 +42,13 @@ Features implemented, pending public release:

---

## v0.6.0 — Plugins System
## v0.7.0 — Plugins System

- [ ] **Plugin Architecture** — Admin-activatable modules

---

## v0.7.0 — Public Tracker Mode
## v0.8.0 — Public Tracker Mode

- [ ] **Public Mode** — Browse and download without account
- [ ] **Anonymous Announces** — Tracking without passkey
Expand Down Expand Up @@ -73,4 +79,4 @@ Features implemented, pending public release:
---

> [!NOTE]
> This roadmap is subject to change based on community feedback and project priorities. Have a feature request? Open an issue on [GitHub](https://github.com/florianjs/opentracker/issues).
> This roadmap is subject to change based on community feedback and project priorities. Have a feature request? Open an issue on [GitHub](https://github.com/florianjs/trackarr/issues).
4 changes: 2 additions & 2 deletions doc/guide/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security Overview

OpenTracker is built with security as a foundational principle, not an afterthought. This page provides an overview of the security architecture.
Trackarr is built with security as a foundational principle, not an afterthought. This page provides an overview of the security architecture.

## Security Layers

Expand All @@ -14,7 +14,7 @@ OpenTracker is built with security as a foundational principle, not an afterthou

## Rate Limits

OpenTracker implements distributed rate limiting to prevent abuse:
Trackarr implements distributed rate limiting to prevent abuse:

| Endpoint | Limit | Action on Abuse |
|----------|-------|-----------------|
Expand Down
2 changes: 1 addition & 1 deletion doc/guide/zero-knowledge-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zero-Knowledge Authentication

OpenTracker uses a **Zero-Knowledge** authentication system where the server **never sees or stores your password**. All cryptographic operations happen client-side in your browser.
Trackarr uses a **Zero-Knowledge** authentication system where the server **never sees or stores your password**. All cryptographic operations happen client-side in your browser.

## How It Works

Expand Down
26 changes: 13 additions & 13 deletions doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: home

hero:
name: OpenTracker
name: Trackarr
text: Modern Private BitTorrent Tracker
tagline: High-performance, security-first tracker with Zero-Knowledge Authentication and Panic Mode encryption.
actions:
Expand All @@ -11,7 +11,7 @@ hero:
link: /guide/getting-started
- theme: alt
text: View on GitHub
link: https://github.com/florianjs/opentracker
link: https://github.com/florianjs/trackarr
- theme: alt
text: Live Demo
link: https://tracker.florianargaud.com/
Expand All @@ -31,21 +31,21 @@ features:
details: Prometheus metrics and Grafana dashboards out of the box. Track peers, announces, and system health in real-time.
---

## Why OpenTracker?
## Why Trackarr?

OpenTracker is designed for communities that value **privacy** and **security** above all else. Unlike traditional trackers that store passwords and personal data in plaintext or with reversible encryption, OpenTracker uses cryptographic proofs that make it mathematically impossible to recover user credentials—even for administrators.
Trackarr is designed for communities that value **privacy** and **security** above all else. Unlike traditional trackers that store passwords and personal data in plaintext or with reversible encryption, Trackarr uses cryptographic proofs that make it mathematically impossible to recover user credentials—even for administrators.

### Tech Stack

| Layer | Technology | Purpose |
|-------|------------|---------|
| Frontend | Nuxt 4, Vue 3, Tailwind CSS | SSR, Composition API |
| Backend | Nitro Server Engine | API routes, middleware |
| Database | PostgreSQL 16 + Drizzle ORM | Data persistence, full-text search |
| Cache | Redis 7 | Peer lists, sessions, rate limiting |
| P2P | bittorrent-tracker | HTTP & WebSocket announces |
| Crypto | Web Crypto API, scrypt, AES-256-GCM | ZKE auth, Panic encryption |
| Monitor | Prometheus + Grafana | Metrics, dashboards, alerting |
| Layer | Technology | Purpose |
| -------- | ----------------------------------- | ----------------------------------- |
| Frontend | Nuxt 4, Vue 3, Tailwind CSS | SSR, Composition API |
| Backend | Nitro Server Engine | API routes, middleware |
| Database | PostgreSQL 16 + Drizzle ORM | Data persistence, full-text search |
| Cache | Redis 7 | Peer lists, sessions, rate limiting |
| P2P | bittorrent-tracker | HTTP & WebSocket announces |
| Crypto | Web Crypto API, scrypt, AES-256-GCM | ZKE auth, Panic encryption |
| Monitor | Prometheus + Grafana | Metrics, dashboards, alerting |

---

Expand Down
4 changes: 2 additions & 2 deletions doc/reference/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Reference

OpenTracker exposes several API endpoints for tracker operations and frontend interactions.
Trackarr exposes several API endpoints for tracker operations and frontend interactions.

## Tracker Endpoints

Expand Down Expand Up @@ -48,7 +48,7 @@ d5:filesd20:{info_hash}d8:completei10e10:downloadedi50e10:incompletei5eeee

## WebSocket Announces

OpenTracker supports WebSocket announces for WebTorrent clients:
Trackarr supports WebSocket announces for WebTorrent clients:

```javascript
const ws = new WebSocket('wss://announce.your-domain.com')
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Environment Variables

Complete reference for all environment variables used by OpenTracker.
Complete reference for all environment variables used by Trackarr.

## Required Variables

Expand All @@ -18,7 +18,7 @@ These must be set for the application to run:

| Variable | Description | Default |
|----------|-------------|---------|
| `NUXT_PUBLIC_SITE_NAME` | Display name of your tracker | `OpenTracker` |
| `NUXT_PUBLIC_SITE_NAME` | Display name of your tracker | `Trackarr` |
| `NUXT_PUBLIC_SITE_URL` | Public URL | — |
| `NUXT_PUBLIC_ANNOUNCE_URL` | Announce URL for torrents | — |
| `NODE_ENV` | Environment mode | `development` |
Expand Down
4 changes: 2 additions & 2 deletions doc/support/professional.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Professional Support

Need help with your OpenTracker installation? I offer professional services to help you get the most out of your private tracker.
Need help with your Trackarr installation? I offer professional services to help you get the most out of your private tracker.

## Services

Expand All @@ -10,7 +10,7 @@ Don't want to deal with server setup? I'll handle everything:

- VPS provisioning and configuration
- DNS and SSL setup
- OpenTracker installation and optimization
- Trackarr installation and optimization
- Security hardening
- Monitoring setup (Prometheus + Grafana)

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "trackarr",
"version": "0.4.0",
"version": "0.4.1",
"type": "module",
"private": true,
"scripts": {
Expand Down