README.md
Rama main · réplica de lectura del repositorio original.
# SubTrackr
A self-hosted subscription management application built with Go and HTMX. Track your subscriptions, visualize spending, and get renewal reminders.
<img src="mobile-screenshot.png" alt="SubTrackr Mobile View" width="320"/>
## ✨ What's New
### v0.7.0
- **To Cancel reminders**: mark a subscription you plan to cancel and get a reminder 3, 5 or 14 days before the last day you can cancel. See [To Cancel reminders](#to-cancel-reminders).
- **ntfy and Gotify notifications**: send reminders and alerts to ntfy.sh or your own ntfy or Gotify server. See [ntfy and Gotify Notifications](#ntfy-and-gotify-notifications).
- **European date format**: `DD.MM.YYYY` joins the existing date preferences.
- **HTMX 4**: the interface runs on HTMX 4, served from SubTrackr itself rather than a CDN. Errors show beside the form that caused them, an expired session sends you to the login page, and the add/edit form works fully from the keyboard.
- **Safer database**: SQLite now runs in WAL mode, which fixes "database is locked" errors. Back up before upgrading; see [Upgrading and backing up existing installations](#upgrading-and-backing-up-existing-installations).
- Saved notification tokens are no longer shown in Settings.
### v0.6.11
- Security fixes for password reset links and email headers. Password reset emails now build their link only from **Settings → Base URL**, so set it if SubTrackr runs behind a reverse proxy.
### v0.6.10
- High-cost alert thresholds above 10,000 are now accepted.
- Security hardening for the calendar and settings pages, and a [security policy](SECURITY.md) for reporting vulnerabilities.
See the [releases page](https://github.com/bscott/subtrackr/releases) for full notes.
## 🎨 Themes
Personalize your SubTrackr experience with 5 beautiful themes:
<table>
<tr>
<td align="center">
<img src="screenshots/christmas.png" alt="Christmas Theme" width="600"/><br/>
<b>Christmas 🎄</b><br/>
Festive and jolly! (with snowfall animation)
</td>
</tr>
<tr>
<td align="center">
<img src="screenshots/ocean.png" alt="Ocean Theme" width="600"/><br/>
<b>Ocean</b><br/>
Cool and refreshing
</td>
</tr>
<tr>
<td align="center">
<img src="screenshots/login.png" alt="Login Page" width="600"/><br/>
<b>Optional Authentication</b><br/>
Secure your data with optional login support
</td>
</tr>
</table>
**Available themes:** Default (Light), Dark, Christmas 🎄, Midnight (Purple), Ocean (Cyan)
Themes persist across all pages and are saved per user. Change themes anytime from Settings → Appearance.
## 🚀 Features
- 📊 **Dashboard Overview**: Real-time stats showing monthly/annual spending
- 💰 **Subscription Management**: Track all your subscriptions in one place with logos
- 📅 **Calendar View**: Visual calendar showing all subscription renewal dates with iCal export and subscription URL
- 📈 **Analytics**: Visualize spending by category and track savings
- 🔔 **Email Notifications**: Get reminders before subscriptions renew
- 📱 **Pushover Notifications**: Receive push notifications on your mobile device
- 🔔 **ntfy and Gotify Notifications**: Push to ntfy.sh or your own ntfy or Gotify server, including over HTTP on your LAN
- ⏰ **To Cancel Reminders**: Get reminded before the last day you can cancel a subscription you no longer want
- 📤 **Data Export**: Export your data as CSV, JSON, or iCal format
- 🎨 **Beautiful Themes**: 5 stunning themes including a festive Christmas theme with snowfall animation
- 🌍 **Multi-Currency Support**: 37 built-in currencies, including USD, EUR, GBP, JPY, INR, BRL and VND (with optional real-time conversion)
- 🤖 **MCP Server**: AI integration via Model Context Protocol for Claude and other AI assistants
- 🐳 **Docker Ready**: Easy deployment with Docker
- 🔒 **Self-Hosted**: Your data stays on your server
- 📱 **Mobile Responsive**: Optimized mobile experience with hamburger menu navigation
- ⌨️ **Keyboard Friendly**: The add/edit form and mobile menu keep keyboard focus inside, close with Escape and return focus where you left off
- 📆 **Date Formats**: `MM/DD/YYYY`, `DD/MM/YYYY`, `YYYY-MM-DD` or `DD.MM.YYYY`
## 🏗️ Tech Stack
- **Backend**: Go with Gin framework
- **Database**: SQLite (no external database needed!)
- **Frontend**: HTMX 4 (served by SubTrackr) + Tailwind CSS
- **Deployment**: Docker & Docker Compose
## 🚀 Quick Start
SubTrackr is available as a multi-platform Docker image supporting AMD64, ARM64 (including Apple Silicon), and ARMv7 architectures.
**Note:** SubTrackr works fully out-of-the-box with no external dependencies. The Fixer.io API key is completely optional for currency conversion features.
### Option 1: Docker Compose (Recommended)
1. **Create docker-compose.yml**:
```yaml
version: '3.8'
services:
subtrackr:
image: ghcr.io/bscott/subtrackr:latest
container_name: subtrackr
ports:
- "8080:8080"
volumes:
- ./data:/app/data
environment:
- GIN_MODE=release
- DATABASE_PATH=/app/data/subtrackr.db
# Optional: Enable automatic currency conversion (requires Fixer.io API key)
# - FIXER_API_KEY=your_fixer_api_key_here
restart: unless-stopped
```
2. **Start the container**:
```bash
docker-compose up -d
```
3. **Access SubTrackr**: Open http://localhost:8080
### Option 2: Docker Run
```bash
docker run -d \
--name subtrackr \
-p 8080:8080 \
-v $(pwd)/data:/app/data \
-e GIN_MODE=release \
ghcr.io/bscott/subtrackr:latest
# Optional: With currency conversion enabled
docker run -d \
--name subtrackr \
-p 8080:8080 \
-v $(pwd)/data:/app/data \
-e GIN_MODE=release \
-e FIXER_API_KEY=your_fixer_api_key_here \
ghcr.io/bscott/subtrackr:latest
```
### Option 3: Build from Source
1. **Clone the repository**:
```bash
git clone https://github.com/bscott/subtrackr.git
cd subtrackr
```
2. **Build and run with Docker Compose**:
```bash
docker-compose up -d --build
```
## 🐳 Deployment Guides
### Portainer
1. **Stack Deployment**:
- Go to Stacks → Add Stack
- Name: `subtrackr`
- Paste the docker-compose.yml content
- Deploy the stack
2. **Environment Variables** (optional):
```
PORT=8080
DATABASE_PATH=/app/data/subtrackr.db
GIN_MODE=release
```
3. **Volumes**:
- Create a volume named `subtrackr-data`
- Mount to `/app/data` in the container
### Proxmox LXC Container
1. **Create LXC Container**:
```bash
# Create container (Ubuntu 22.04)
pct create 200 local:vztmpl/ubuntu-22.04-standard_22.04-1_amd64.tar.gz \
--hostname subtrackr \
--memory 512 \
--cores 1 \
--net0 name=eth0,bridge=vmbr0,ip=dhcp \
--storage local-lvm \
--rootfs local-lvm:8
```
2. **Install Docker in LXC**:
```bash
pct start 200
pct enter 200
# Update and install Docker
apt update && apt upgrade -y
curl -fsSL https://get.docker.com | sh
```
3. **Deploy SubTrackr**:
```bash
mkdir -p /opt/subtrackr
cd /opt/subtrackr
# Create docker-compose.yml
nano docker-compose.yml
# Paste the docker-compose content
docker-compose up -d
```
### Unraid
1. **Community Applications**:
- Search for "SubTrackr" in CA
- Configure paths and ports
- Apply
2. **Manual Docker Template**:
- Repository: `ghcr.io/bscott/subtrackr:latest`
- Port: `8080:8080`
- Path: `/app/data` → `/mnt/user/appdata/subtrackr`
### Synology NAS
1. **Using Docker Package**:
- Open Docker package
- Registry → Search "subtrackr"
- Download latest image
- Create container with port 8080 and volume mapping
2. **Using Container Manager** (DSM 7.2+):
- Project → Create
- Upload docker-compose.yml
- Build and run
## 🔧 Configuration
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `PORT` | Server port | `8080` |
| `DATABASE_PATH` | SQLite database file path | `./data/subtrackr.db` |
| `GIN_MODE` | Gin framework mode (debug/release) | `debug` |
| `FIXER_API_KEY` | Fixer.io API key for currency conversion (optional) | None |
### Currency Conversion (Optional)
SubTrackr supports automatic currency conversion using Fixer.io exchange rates:
**Without API key:** (Fully functional)
- Basic multi-currency support with display symbols
- Manual currency selection per subscription
- Subscriptions displayed in their original currency
- No automatic conversion between currencies
**With Fixer.io API key:**
- Real-time exchange rates (cached for 24 hours)
- Automatic conversion between any supported currencies
- Display original amount + converted amount in your preferred currency
**Setup:**
1. Sign up for free at [Fixer.io](https://fixer.io/) (1000 requests/month)
2. Get your API key from the dashboard
3. Add `FIXER_API_KEY=your_key_here` to your environment variables
4. Restart SubTrackr - currency conversion will be automatically enabled
**Note:** The free Fixer.io plan only allows EUR as the base currency. SubTrackr automatically handles cross-rate calculations (e.g., USD→INR goes through EUR) so all currency conversions work correctly regardless of this limitation.
**Supported currencies:** USD, EUR, GBP, AUD, CAD, NZD, JPY, CHF, CNY, SEK, NOK, DKK, INR, RUB, BRL, PLN, KRW, SGD, HKD, MXN, ZAR, TRY, THB, COP, BDT, IDR, PHP, TWD, MYR, AED, SAR, ILS, CZK, HUF, RON, UAH, VND
### Email Notifications (SMTP)
Configure SMTP settings in the web interface:
1. Navigate to Settings → Email Notifications
2. Enter your SMTP details:
- **Gmail**: smtp.gmail.com:587
- **Outlook**: smtp-mail.outlook.com:587
- **Custom**: Your SMTP server details
3. Test connection
4. Enable renewal reminders
### Pushover Notifications
Receive push notifications on your mobile device via Pushover:
1. **Get your Pushover credentials**:
- Sign up at [pushover.net](https://pushover.net/) (free account)
- Get your User Key from the dashboard
- Create an application at [pushover.net/apps/build](https://pushover.net/apps/build) to get an Application Token
2. **Configure in SubTrackr**:
- Navigate to Settings → Pushover Notifications
- Enter your User Key and Application Token
- Click "Test Connection" to verify configuration
- Save settings
3. **Notification Types**:
- **Renewal Reminders**: Get notified before subscriptions renew (uses the same reminder days setting as email)
- **High Cost Alerts**: Receive alerts when adding expensive subscriptions (uses the same threshold as email alerts)
**Note**: Pushover notifications work alongside email notifications. Both will be sent when enabled, giving you multiple ways to stay informed about your subscriptions.
### ntfy and Gotify Notifications
<img src="screenshots/v0.7.0-ntfy-gotify.png" alt="ntfy and Gotify settings" width="700"/>
Send the same renewal, cancellation and high-cost notifications to a self-hostable push server. Both work over HTTPS and over plain HTTP on your LAN.
**ntfy** (Settings → ntfy Notifications):
- **Server URL**: defaults to `https://ntfy.sh`; enter your own server if you host one
- **Topic**: letters, digits, `-` and `_`. On a public server anyone who knows the topic can read it, so pick one that is hard to guess
- **Access Token**: optional, for protected topics
- **Priority**: 1 (min) to 5 (max)
**Gotify** (Settings → Gotify Notifications):
- **Server URL**: the address of your Gotify server
- **Application Token**: create an application under Apps in Gotify
- **Priority**: 0 to 10
**Test Connection** sends a message using what is currently in the form without saving it. Saved tokens are never shown again: leave the field blank to keep a token. If you change the server URL you must enter the token again, so a saved token is never sent to a server it was not entered for.
### To Cancel reminders
Mark a subscription **To cancel** and choose a reminder 3, 5 or 14 days before its deadline. The deadline is the renewal date minus any cancellation notice period. Active and Trial subscriptions are eligible; Paused subscriptions retain the choice but do not send. Marking a subscription Cancelled clears it.
This choice works independently of regular renewal reminders and suppresses the regular renewal message for that subscription. A reminder is recorded only when at least one configured channel accepts it. Failed delivery is retried on the next daily check while the deadline is still upcoming. After partial delivery, channels that failed are not retried separately.
Missed deadlines are shown in the app and do not generate late reminders. If the notice period is as long as the billing cycle, the current deadline may already be missed. Active renewals roll forward automatically (on the renewal day); Trial dates remain fixed until edited. Choose a lead time that leaves time to act, rather than relying on a notification on the final day. The intent and delivery history survive backup/restore; duplicating a subscription starts a new reminder history.
Date preferences include `MM/DD/YYYY`, `DD/MM/YYYY`, `YYYY-MM-DD` and `DD.MM.YYYY`. CSV and calendar exports keep their machine-readable date formats.
### Data Persistence
**Important**: Always mount a volume to `/app/data` to persist your database!
```yaml
volumes:
- ./data:/app/data # Local directory
# OR
- subtrackr-data:/app/data # Named volume
```
## Upgrading and backing up existing installations
Before upgrading to v0.7.0, stop every SubTrackr process that uses the database, including the web server and MCP server. Make a backup of the entire data directory while they are stopped, and keep the previous image/version and configuration with that backup. Start only one process for the first upgrade so migrations can finish before other clients open the database.
v0.7.0 uses SQLite WAL mode. The database can have `-wal` and `-shm` companion files beside it; copying only the `.db` file while the app is running can omit recent writes. Use a stopped backup of the complete directory, or a SQLite-aware online backup tool. Copying individual live files separately is not a consistent backup. Store the database on local storage; SQLite WAL is not suitable for NFS/SMB network filesystems.
After upgrading, verify subscriptions, categories/tags, settings, reminders and exports before resuming normal use. To roll back, stop all processes and restore the pre-upgrade data directory with the previous application version. Do not point an older version at the upgraded database: its migrations can rebuild tables, reuse deleted IDs and discard custom indexes. A rollback from backup also discards changes made after that backup.
Committed upgrade tests cover a captured v0.6.10 fresh-install schema, a v0.3.0 schema upgraded through v0.6.10, and two older schema shapes with synthetic data, including repeated migrations and failure recovery. Direct upgrades from v0.1.0/v0.2.0 are not validated for application use; those schemas have a pre-existing missing-category-column issue. Custom single-column UNIQUE indexes can make GORM rebuild the affected table on each startup; the migration preserves their data and metadata, but this increases startup work. These tests do not guarantee compatibility with every customized or long-lived database, so retain and verify your backup.
## 🔐 Security Recommendations
1. **Reverse Proxy**: Use Nginx/Traefik for HTTPS
2. **Authentication**: Add basic auth or OAuth2 proxy
3. **Network**: Don't expose port 8080 directly to internet
4. **Backups**: Regular backups of the data directory (see [Upgrading and backing up existing installations](#upgrading-and-backing-up-existing-installations))
5. **Base URL**: Behind a reverse proxy, set **Settings → Base URL** to your public address. Password reset emails and iCal subscription links use it.
To report a vulnerability, follow the [security policy](SECURITY.md) rather than opening a public issue.
### Nginx Reverse Proxy Example
```nginx
server {
server_name subtrackr.yourdomain.com;
location / {
proxy_pass http://localhost:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
```
### Traefik Labels
```yaml
labels:
- "traefik.enable=true"
- "traefik.http.routers.subtrackr.rule=Host(`subtrackr.yourdomain.com`)"
- "traefik.http.routers.subtrackr.entrypoints=websecure"
- "traefik.http.routers.subtrackr.tls.certresolver=letsencrypt"
```
## 📊 API Documentation
SubTrackr provides a RESTful API for external integrations. All API endpoints require authentication using an API key.
### Authentication
Create an API key from the Settings page in the web interface. Include the API key in your requests using one of these methods:
```bash
# Authorization header (recommended)
curl -H "Authorization: Bearer sk_your_api_key_here" https://your-domain.com/api/v1/subscriptions
# X-API-Key header
curl -H "X-API-Key: sk_your_api_key_here" https://your-domain.com/api/v1/subscriptions
```
### API Endpoints
#### Subscriptions
| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/api/v1/subscriptions` | List all subscriptions |
| POST | `/api/v1/subscriptions` | Create a new subscription |
| GET | `/api/v1/subscriptions/:id` | Get subscription details |
| PUT | `/api/v1/subscriptions/:id` | Update subscription |
| DELETE | `/api/v1/subscriptions/:id` | Delete subscription |
The `autopay` field is nullable: `true` means payments are automatic, `false` means manual payment is required, and `null` means the payment mode has not been recorded.
The `cancellation_notice_days` field holds the notice period (in days, 0-365) the provider requires before renewal; `0` means none. When set, renewal reminders count down to the cancel-by deadline (`renewal_date` minus the notice period) instead of the renewal date; once the deadline has passed, reminders fall back to the renewal date. Webhook reminders keep the `renewal_reminder` event name and carry `cancel_by_date` and `cancellation_notice_days` in the subscription payload. Send the field form-encoded like the other subscription fields.
#### Statistics & Export
| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/api/v1/stats` | Get subscription statistics |
| GET | `/api/v1/export/csv` | Export subscriptions as CSV |
| GET | `/api/v1/export/json` | Export subscriptions as JSON |
### Example Requests
#### List Subscriptions
```bash
curl -H "Authorization: Bearer sk_your_api_key_here" \
https://your-domain.com/api/v1/subscriptions
```
#### Create Subscription
```bash
curl -X POST \
-H "Authorization: Bearer sk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "Netflix",
"cost": 15.99,
"schedule": "Monthly",
"status": "Active",
"category": "Entertainment"
}' \
https://your-domain.com/api/v1/subscriptions
```
#### Update Subscription
```bash
curl -X PUT \
-H "Authorization: Bearer sk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"cost": 17.99,
"status": "Active"
}' \
https://your-domain.com/api/v1/subscriptions/123
```
#### Get Statistics
```bash
curl -H "Authorization: Bearer sk_your_api_key_here" \
https://your-domain.com/api/v1/stats
```
Response:
```json
{
"total_count": 15,
"active_count": 12,
"total_cost": 245.67,
"categories": {
"Entertainment": 45.99,
"Productivity": 89.00,
"Storage": 29.99
}
}
```
## 🤖 MCP Server (AI Integration)
SubTrackr includes a [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that allows AI assistants like Claude to read and manage your subscriptions via natural language.
### Available Tools
| Tool | Description |
|------|-------------|
| `list_subscriptions` | List all subscriptions |
| `get_subscription` | Get a subscription by ID |
| `create_subscription` | Create a new subscription |
| `update_subscription` | Update an existing subscription |
| `delete_subscription` | Delete a subscription |
| `get_stats` | Get subscription statistics |
### Setup
#### Local Install
Build the MCP server binary:
```bash
go build -o subtrackr-mcp ./cmd/mcp
```
Add to your Claude Desktop (`claude_desktop_config.json`) or Claude Code (`.claude/settings.json`):
```json
{
"mcpServers": {
"subtrackr": {
"command": "/path/to/subtrackr-mcp",
"env": {
"DATABASE_PATH": "/path/to/subtrackr.db"
}
}
}
}
```
#### Docker
The MCP binary is included in the Docker image. Configure your MCP client to exec into the container:
```json
{
"mcpServers": {
"subtrackr": {
"command": "docker",
"args": ["exec", "-i", "subtrackr", "/app/subtrackr-mcp"]
}
}
}
```
The MCP server shares the same SQLite database as the web server, so changes made through either interface are immediately visible in the other.
## 🛠️ Development
### Prerequisites
- Go 1.21+
- Docker (optional)
### Local Development
```bash
# Install dependencies
go mod download
# Run development server
go run cmd/server/main.go
# Build binary
go build -o subtrackr cmd/server/main.go
```
### Building Docker Image
```bash
# Build for current platform
docker build -t subtrackr:latest .
# Build multi-platform
docker buildx build --platform linux/amd64,linux/arm64 \
-t subtrackr:latest --push .
```
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- Built with [Gin](https://gin-gonic.com/) web framework
- UI powered by [HTMX](https://htmx.org/) and [Tailwind CSS](https://tailwindcss.com/)
- Icons from [Heroicons](https://heroicons.com/)
## ⚠️ Known Limitations
- **Price History**: SubTrackr currently tracks only the current price per subscription. If a subscription changes price over time, annual spend calculations will be based on the current price multiplied by the billing cycle, which may not reflect actual historical spending. For accurate historical tracking, consider manually updating subscription costs when prices change or keeping external records.
## 📞 Support
- 🐛 Issues: [GitHub Issues](https://github.com/bscott/subtrackr/issues)
- 💬 Discussions: [GitHub Discussions](https://github.com/bscott/subtrackr/discussions)
---
Made with ❤️ by me and Vibing