https://github.com/s0up4200/ptparchiver-go
A Go implementation of PTP Archive Team client utility that allows you to allocate "containers" that PTP will provide neglected torrents to archive in. You cannot control what content is put in those containers.
https://github.com/s0up4200/ptparchiver-go
Last synced: 15 days ago
JSON representation
A Go implementation of PTP Archive Team client utility that allows you to allocate "containers" that PTP will provide neglected torrents to archive in. You cannot control what content is put in those containers.
- Host: GitHub
- URL: https://github.com/s0up4200/ptparchiver-go
- Owner: s0up4200
- License: mit
- Created: 2025-01-02T17:07:36.000Z (9 months ago)
- Default Branch: develop
- Last Pushed: 2025-09-06T07:03:36.000Z (about 1 month ago)
- Last Synced: 2025-09-19T22:29:50.142Z (19 days ago)
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PTP Archiver Go
A Go implementation of PTP Archive Team client utility that allows you to allocate "containers" that PTP will provide neglected torrents to archive in. You cannot control what content is put in those containers. Supports qBittorrent, rTorrent, Deluge, and watchDir.
## Table of Contents
- [Installation](#installation)
- [Downloading the binary](#downloading-the-binary)
- [Docker Compose](#docker-compose)
- [Homebrew](#homebrew)
- [Building from Source](#building-from-source)
- [Installing using Go](#installing-using-go)
- [Quick Start](#quick-start)
- [Configuration](#configuration-example)
- [Container Settings](#container-settings-explained)
- [Space Management](#space-management)
- [Usage](#usage)
- [Running as a Service](#running-as-a-service)
## Installation
### Downloading the binary
1. Download the binary for your operating system from the [releases page](https://github.com/s0up4200/ptparchiver-go/releases/latest).
If you run linux x86_64, you can use the following command to download the latest release:
```bash
wget $(curl -s https://api.github.com/repos/s0up4200/ptparchiver-go/releases/latest | grep download | grep linux_x86_64 | cut -d\" -f4)
```
2. Extract the binary to `/usr/local/bin`:
```bash
sudo tar -C /usr/local/bin -xzf ptparchiver*.tar.gz
```
3. Verify the installation:
```bash
ptparchiver --help
```
### Docker Compose
See [docker-compose.yml](docker-compose.yml) for an example.
```bash
docker compose up -d
```
### Homebrew
```bash
brew tap s0up4200/ptparchiver-go
brew install ptparchiver-go
```
### Building from Source
Requires Go to be installed. Get it from [here](https://go.dev/dl/).
```bash
git clone https://github.com/s0up4200/ptparchiver-go.git
cd ptparchiver-go
go build -o ptparchiver ./cmd/archiver
```
### Installing using Go
Requires Go to be installed. Get it from [here](https://go.dev/dl/).
```bash
go install github.com/s0up4200/ptparchiver-go/cmd/ptparchiver@latest
```
Make sure your Go binary path is added to your system's PATH:
- For Linux/macOS, add to `~/.bashrc` or `~/.zshrc`:
```bash
export PATH=$PATH:$(go env GOPATH)/bin
```
- For Windows, add `%USERPROFILE%\go\bin` to your system's PATH environment variable
## Quick Start
1. Initialize a config file:
```bash
ptparchiver init
```
2. Edit the generated config file (located in either current directory or `~/.config/ptparchiver-go/config.yaml`)
```bash
nano ~/.config/ptparchiver-go/config.yaml
```
3. Start archiving:
```bash
# Fetch torrents for all active containers
ptparchiver fetch
# Fetch torrents for a specific container
ptparchiver fetch container1
```
## Configuration Example
Remove or comment out any sections you don't need.
```yaml
# PTP API credentials
apiKey: your-api-key
apiUser: your-api-user
baseUrl: https://passthepopcorn.me
# Define qBittorrent clients
qbittorrent:
seedbox1:
url: http://localhost:8080
username: admin
password: adminadmin
basicUser: "" # optional HTTP basic auth
basicPass: "" # optional HTTP basic auth
# Define rTorrent clients
rtorrent:
remote_server:
url: http://mydomain.com/rutorrent/plugins/httprpc/action.php # Remote ruTorrent XMLRPC endpoint
basicUser: "" # Optional HTTP basic auth username
basicPass: "" # Optional HTTP basic auth password
local_server:
url: https://127.0.0.1/rutorrent/plugins/httprpc/action.php # Local ruTorrent XMLRPC endpoint
# Define Deluge clients
deluge:
deluge1:
host: localhost # Deluge daemon hostname
port: 58846 # Deluge daemon port
username: admin # Deluge daemon username
password: adminadmin # Deluge daemon password
basicUser: "" # Optional HTTP basic auth
basicPass: "" # Optional HTTP basic auth
# Define archive containers
containers:
qbit-container:
size: 5T
maxStalled: 5 # Only for qBittorrent and rTorrent
category: ptp-archive
client: qbit1
startPaused: false # Optional, add torrents in paused state
rtorrent-container:
size: 5T
maxStalled: 5 # Only for qBittorrent and rTorrent
category: ptp-archive
client: rtorrent1
startPaused: false
deluge-container:
size: 5T
category: ptp-archive
client: deluge1
startPaused: false # Optional, add torrents in paused state
watch-container:
size: 5T # Total storage allocation
watchDir: /path/to/watch/directory # Directory to save .torrent files to
fetchSleep: 5 # Seconds between API requests, do not set lower than 5 unless you want to get banned
interval: 360 # Minutes between fetch attempts when running as a service (default: 6 hours)
```
### Container Settings Explained
- `size`: Total storage allocation for this container. This is used by PTP to track total allocation, not for local space management.
- `maxStalled`: When this many torrents in the container have stalled downloads (not uploads), the client will stop fetching new torrents until some complete or are removed. A download is considered stalled when it cannot progress due to no available peers. This setting works with qBittorrent and rTorrent containers but has no effect on Deluge or watchDir containers.
- `category`: Category/label to assign to downloaded torrents (works with all clients)
- `tags`: Optional tags to assign to downloaded torrents (qBittorrent only)
- `client`: Which torrent client configuration to use for this container (required for qBittorrent, rTorrent, and Deluge containers)
- `watchDir`: Directory to save .torrent files to (required for watchDir containers)
- `startPaused`: Add torrents in a stopped/paused state (optional, works with all clients)
- `addPaused`: Alias for startPaused for backward compatibility
You must specify either `client` for qBittorrent/rTorrent/Deluge or `watchDir` for watch directory mode. The two modes cannot be used together in the same container.
### Space Management
For qBittorrent and Deluge containers:
- Checks available space in the client's download directory
- Requires enough free space for the torrent size plus a 10% buffer
- Skips the torrent if insufficient space is available
For rTorrent and watchDir containers:
- No space management is performed at this time
- Your torrent client will need to handle space management
- Consider adding as paused
## Usage
```bash
# Initialize new config
ptparchiver init
# Run as a service
ptparchiver run # Run continuously using interval from config (default: 6 hours)
ptparchiver run --interval 30 # Override config and fetch every 30 minutes
# Fetch torrents for all containers
ptparchiver fetch
# Fetch torrents for specific container
ptparchiver fetch hetzner
# Use custom config location
ptparchiver --config /path/to/config.yaml fetch
# Enable debug logging
ptparchiver --debug fetch
# Show help
ptparchiver help
```
### Running as a Service
The `run` command starts ptparchiver in service mode, continuously fetching torrents at a specified interval. The interval can be configured in three ways (in order of precedence):
1. Command line flag: `--interval `
2. Config file: `interval: `
3. Default value: 360 minutes (6 hours)
When running in Docker, you can configure the interval in your docker-compose.yml:
```yaml
services:
ptparchiver:
image: ghcr.io/s0up4200/ptparchiver-go:latest
container_name: ptparchiver
volumes:
- ./config:/config
command: run # Runs as a service using interval from config or by setting --interval
```
## GitHub Stats
