Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 5.48 KB

README_docker.md

File metadata and controls

101 lines (68 loc) · 5.48 KB
Raw

Overview

Deployment

First run

More usages and precautions

Overview

This project integrates yt-dlp & its Web frontend metube, gallery-dl, Aria2 + WebUI, qBittorrent + VueTorrent WebUI, pyLoad Download Manager, Rclone + WebUI with auto-upload function, Rclone Serve HTTP & Webdav, Filebrowser, Telegram notification.

  1. Rclone auto-upload function only needs to prepare rclone.conf file, and all other configurations are set to go.
  2. AMD64/Arm64 multi-architecture support.
  3. Execute predefined yt-dlp, gallery-dl & Rclone commands from OliveTin WebUI.
  4. Rclone runs on daemon mode, easy to manually transfer files and monitor transfers in real time on WebUI.
  5. You can connect to Aria2, qBittorrent from other frontends/services，including Telegram bot/flexget/Radarr/Sonarr.
  6. runit-based process management, each service can be started and stopped independently.
  7. There are independent logs for each service in the log directory.

Deployment

  1. Download docker-compose file. Lite version without pyLoad has smaller image size.

  2. Set envs and run container with following command:

        docker-compose -f docker-compose_en.yml up -d

First run

  1. visit your_domain/ip_address + ${GLOBAL_PORTAL_PATH} to reach portal page.

  2. Click AriaNg, then authentication failure warning will pop up, fill in Aria2 secret RPC token with password set during deployment and check whether protocol and port settings match what is displayed in the browser address bar.

  3. Open log/qBittorrent/current file under docker volume diretory to get qBit temporary password. Click qBittorrent or VueTorrent, type default username admin and temporary password to login. Change default user/password to your own. Recommend strong password.

    If you can't log in qBittorrent with the default account/password. Delete config/qBittorrent/config/qBittorrent.conf file via Filebrowser, then run the following command in host terminal:

       docker exec allinone sv restart qBittorrent
  1. It's not possible to configure a Rclone remote which requires web authentication through Rclone web UI in this app. You need to upload rclone.conf file to config folder via Filebrowser, you can edit script.conf file to change Rclone auto-upload settings.
  2. If you can't find function settings added in new version in script.conf after upgrading, refer to the latest script.conf file，and add missing setting options by yourself.

More usages and precautions

  1. To enable Telegram notification function, you need to talk to @BotFather in Telegram to register a bot. Get ChatID of your Telegram account or ChatID of the channel which bot joined. Please Google for detailed steps.

    Edit the config/script.conf file. Fill in the corresponding options for botid:token and ChatID, then the notification function will take effect.

  2. You can set up proxy for metube in config/metube.conf:

       YTDL_OPTIONS="{\"postprocessors\":[{\"key\":\"Exec\",\"exec_cmd\":\"ytdlptorclone.sh\"}],\"proxy\":\"socks5://127.0.0.1:10808\",\"noprogress\":true}"

  1. How to use yt-dlp & gallery-dl via command line：

        docker exec allinone yt-dlp
    # Built-in script：dlpr
    # Download videos to videos folder, then send job to Rclone.
    docker exec allinone dlpr https://www.youtube.com/watch?v=rbDzVzBsbGM

    docker exec allinone gallery-dl
    # Built-in script：gdlr
    # Download files to gallery_dl_downloads folder, then send job to Rclone.
    docker exec allinone gdlr https://www.reddit.com/r/aww/comments/vb14vy/urgent_baby_flamingo_doing_flamingo_leg/

  2. For apps which don't support custom path for qBittorrent, uncomment followings line in Caddyfile under config/caddy folder:

        handle /api* {       
            reverse_proxy * localhost:61804
    }

    Then run following command for change to take effect:

        docker exec allinone sv restart caddy

  3. Aria2 JSON-RPC path： ${GLOBAL_PORTAL_PATH}/jsonrpc
    Aria2 XML-RPC path： ${GLOBAL_PORTAL_PATH}/rpc

  4. Considering security reasons, the initial user of Filebrowser doesn't have administrator privileges. If administrator privileges are wanted, run following commands:

        docker exec -it allinone sh
    # enter container shell
    sv stop filebrowser
    # stop filebrowser service
    filebrowser -d /mnt/data/config/filebrowser.db users add username password --perm.admin
    # add new account with admin privileges
    sv start filebrowser
    # start filebrowser service

  5. Known pyLoad bugs：

    • Redirect to http after login，solution: close the pyLoad page and reopen it.
    • Fail to delete archives after extraction, solution: Settings--Plugins--ExtractArchive, set "Move to trash instead delete" to off.

  6. After adding following content to rclone.conf file, you can use local storage as a Rclone remote for manually uploading via Rclone Web UI.

        [local]
    type = alias
    remote = /mnt/data