https://github.com/0xnonames/ghostbox
Downloads torrents from a watched directory without affecting your ratio.
https://github.com/0xnonames/ghostbox
golang torrent-client ygg yggtorrent
Last synced: 1 day ago
JSON representation
Downloads torrents from a watched directory without affecting your ratio.
- Host: GitHub
- URL: https://github.com/0xnonames/ghostbox
- Owner: 0xNoNames
- License: apache-2.0
- Created: 2024-11-16T17:33:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T23:34:00.000Z (11 months ago)
- Last Synced: 2025-03-29T08:43:38.500Z (6 months ago)
- Topics: golang, torrent-client, ygg, yggtorrent
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GhostBox
> Based on [GhostYgg](https://github.com/GuillaumeMCK/GhostYgg)
This application will automatically download any torrent files placed in a designated watched directory, which can be specified via a command-line option or a Docker volume.
The torrent client is configured to avoid sending any information to the torrent tracker, ensuring that the download ratio remains unaffected.
## Installation
### Using Docker (recommended)
Simply pull the image from Docker Hub using `docker pull xnonames/ghostbox:latest` or go directly to [Docker CLI](#docker-cli) or [Docker Compose](#docker-compose) sections.
### From Binary
You can download the pre-built binaries for your platform from the [releases](https://github.com/0xNoNames/GhostBox/releases) page.
### Using Go
If you are using Go v1.20 or higher, you can install GhostBox using the following command:
```bash
go install -v github.com/0xNoNames/GhostBox@latest
```
### From Source
To get started with GhostBox, follow these steps:
```bash
git clone https://github.com/0xNoNames/GhostBox.git
cd GhostBox
go build GhostBox.go
./GhostBox
```
## Usage
> [!CAUTION]
> You are responsible for the torrents you download with GhostBox.
### Docker CLI
```sh
docker run --rm \
--name ghostbox \
-e PUID=501 \
-e PGID=501 \
-v ./downloads:/app/downloads \
-v ./torrents:/app/torrents \
xnonames/ghostbox:latest
```
### Docker Compose
```yaml
---
services:
ghostbox:
image: xnonames/ghostbox:latest
container_name: ghostbox
environment:
- PUID=501
- PGID=501
volumes:
- ./downloads:/app/downloads
- ./torrents:/app/torrents
restart: unless-stopped
```
### Using the binary
```sh
./GhostBox -i ./torrents -o ./downloads
```
With the following options:
- `-i`: Specifies the watched directory, where the ".torrent" files will be added.
- `-o`: Specifies the output directory, where the downloaded files will be stored.
- `-help`: Displays the help message.