anthonyraymond/joal repository overview

⁠Github project page

https://github.com/anthonyraymond/joal⁠

⁠Disclamer

JOAL is not designed to help or encourage you downloading illegal materials ! You must respect the law applicable in your country. I couldn't be held responsible for illegal activities performed by your usage of JOAL.

⁠Getting started

Download the latest tar.gz release⁠. Put config.json, clients, and torrents folder into the location of your choice (this will be your configuration folder). For the rest of this README, it will be named joal-conf.

The folder should look like this:

⁠How to run

In next command you have to replace PATH_TO_CONF, PORT, SECRET_OBFUSCATION_PATH and SECRET_TOKEN with your desired values.

docker run -d \
    -p PORT:PORT \
    -v PATH_TO_CONF:/data \
    --name="joal" \
    anthonyraymond/joal \
    --joal-conf="/data" \
    --spring.main.web-environment=true \
    --server.port="PORT" \
    --joal.ui.path.prefix="SECRET_OBFUSCATION_PATH" \
    --joal.ui.secret-token="SECRET_TOKEN"

• PATH_TO_CONF is a required argument: path to the joal-conf folder on host (ie: /home/anthony/joal-conf).

• --spring.main.web-environment=true: to enable the web context.
• --server.port=YOUR_PORT: the port to be used for both HTTP and WebSocket connection.
• --joal.ui.path.prefix="SECRET_OBFUSCATION_PATH": use your own complicated path here (this will be your first layer of security to keep joal secret). This is security though obscurity, but it is required in our case. This must contains only alphanumeric characters (no slash, backslash, or any other non-alphanum char)
• --joal.ui.secret-token="SECRET_TOKEN": use your own secret token here (this is some kind of a password, choose a complicated one).

Once joal is started head to: http://host:port/SECRET_OBFUSCATION_PATH/ui/ (obviously, replace SECRET_OBFUSCATION_PATH) by the value you've chosen

If you want to use iframe you may also pass --joal.iframe.enabled=true argument. If you don't known what that is just ignore it.

Multiple architectures are availables. If you want to run on arm (raspberry) replace anthonyraymond/joal with anthonyraymond/joal:X.X.X-arm where X.X.X are the desired version of joal.

⁠Configuration file

⁠Application configuration

The application configuration belongs in joal-conf/config.json.

{
  "minUploadRate" : 30,
  "maxUploadRate" : 160,
  "simultaneousSeed" : 20,
  "client" : "qbittorrent-3.3.16.client",
  "keepTorrentWithZeroLeechers" : true
}

• minUploadRate : The minimum uploadRate you want to fake (in kB/s) (required)
• maxUploadRate : The maximum uploadRate you want to fake (in kB/s) (required)
• simultaneousSeed : How many torrents should be seeding at the same time (required)
• client : The name of the .client file to use in joal-conf/clients/ (required)
• keepTorrentWithZeroLeechers: should JOAL keep torrent with no leechers or seeders. If yes, torrent with no peers will be seed at 0kB/s. If false torrents will be deleted on 0 peers reached. (required)