https://github.com/RoyXiang/putcallback
https://github.com/RoyXiang/putcallback
putio
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/RoyXiang/putcallback
- Owner: RoyXiang
- License: gpl-3.0
- Created: 2022-01-10T13:39:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T11:32:02.000Z (almost 2 years ago)
- Last Synced: 2024-09-07T12:41:18.819Z (almost 2 years ago)
- Topics: putio
- Language: Go
- Homepage:
- Size: 313 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# putcallback
`putcallback` is a program which handles callback from [Put.io](https://put.io/).
It will move files from Put.io to any other storage supported by [rclone](https://rclone.org/).
## Prerequisites
1. Please ensure `rclone` is installed (version >= 1.52.0)
2. Please ensure both `src` and `dest` are configured as valid rclone remotes,
and `src` should be a remote whose type is `putio`.
## Install
Download from [Releases](https://github.com/RoyXiang/putcallback/releases/latest), or build by yourself:
```sh
env CGO_ENABLED=0 go install -trimpath -ldflags="-s -w" github.com/RoyXiang/putcallback@latest
```
## Usage
1. Setup environment variables
* `REMOTE_SRC` and `REMOTE_DEST` (default: `src:` and `dest:`)
* If something like `rclone move putio: drive:Downloads/` is wanted,
set `REMOTE_SRC` to `putio:` and `REMOTE_DEST` to `drive:Downloads/`
* `MAX_TRANSFERS` (default: the maximum number of simultaneous tasks allowed by your Put.io subscription)
* `DELAY_BEFORE_TRANSFER` (default: `0s`)
* Delay before moving files to the destination so that you can manipulate files on Put.io first
* `EXCLUDE_FILETYPES` (e.g. `exe,log`)
* Certain file types may be excluded from transferring
* `RENAMING_STYLE`: `tv` or `anime` (default: `none`)
* If this is set, all files downloaded by single-file transfers
would be renamed so to be identified by media systems like Plex, Emby, Jellyfin, etc.
* `PUSHOVER_APP_TOKEN` and `PUSHOVER_USER_TOKEN`
* If these two are set, a notification would be sent through [Pushover](https://pushover.net/) after files transferred to `dest`.
* `TELEGRAM_BOT_TOKEN` and `TELEGRAM_CHAT_ID`
* If these two are set, a notification would be sent through Telegram bot after files transferred to `dest`.
2. Run the program. Set it up as a service by any means, e.g. systemd, nohup, supervisor, etc.
3. Make it accessible from outside. The program listens on `:1880` by default, set up a proxy to that port.
4. Set up callback URL on [Settings](https://app.put.io/account/settings/transfers/callback-url) page,
e.g. `http://[your ip]:1880/`