GhostBox

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

README

GhostBox

Based on 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

From Binary

You can download the pre-built binaries for your platform from the releases page.

Using Go

If you are using Go v1.20 or higher, you can install GhostBox using the following command:

go install -v github.com/0xNoNames/GhostBox@latest
From Source

To get started with GhostBox, follow these steps:

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
docker run --rm \
           --name ghostbox \
           -e PUID=501 \
           -e PGID=501 \
           -v ./downloads:/app/downloads \
           -v ./torrents:/app/torrents \
          xnonames/ghostbox:latest
Docker Compose
---
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
./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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL