2.9 KiB
Task Hooks Guide
MyTube allows you to execute custom shell scripts at various stages of a download task's lifecycle. This feature is powerful for integrating MyTube with other systems, performing post-processing on downloaded files, or sending notifications.
available Hooks
You can configure commands for the following events:
| Hook Name | Trigger Point | Description |
|---|---|---|
Before Task Start (task_before_start) |
Before download begins | Executed immediately before the download process starts. Useful for setup or validation. |
Task Success (task_success) |
After successful download | Executed after the file is successfully downloaded / merged, but before it is uploaded to cloud storage (if enabled) or deleted. This is the ideal place for file processing. |
Task Failed (task_fail) |
On task failure | Executed if the download fails for any reason. |
Task Cancelled (task_cancel) |
On task cancellation | Executed when a user manually cancels a running task. |
Environment Variables
When a hook command is executed, the following environment variables are injected into the shell environment, providing context about the task:
| Variable | Description | Example |
|---|---|---|
MYTUBE_TASK_ID |
The unique identifier of the task | 335e98f0-15cb-46a4-846d-9d4351368923 |
MYTUBE_TASK_TITLE |
The title of the video/task | Awesome Video Title |
MYTUBE_SOURCE_URL |
The original URL of the video | https://www.youtube.com/watch?v=... |
MYTUBE_TASK_STATUS |
The current status of the task | success, fail, cancelled |
MYTUBE_VIDEO_PATH |
Absolute path to the downloaded video file | /app/downloads/video.mp4 |
MYTUBE_THUMBNAIL_PATH |
Absolute path to the thumbnail file | /app/downloads/video.jpg |
MYTUBE_ERROR |
Error message (only for task_fail) |
Network timeout |
Configuration
You can configure hooks in the web interface:
- Go to Settings.
- Scroll down to Advanced Settings.
- Find the Task Hooks section.
- Enter your shell commands for the desired events.
- Click Save.
Examples
1. Simple Logging
Log every successful download to a file.
Hook: task_success
echo "[$(date)] Downloaded: $MYTUBE_TASK_TITLE" >> /path/to/mytube_downloads.log
2. Send Notification (e.g., ntfy.sh)
Send a notification when a task fails.
Hook: task_fail
curl -d "MyTube Download Failed: $MYTUBE_TASK_TITLE - $MYTUBE_ERROR" https://ntfy.sh/my_topic
3. File Post-Processing
Run a script to process the file (e.g., move it or re-encode it).
Hook: task_success
/path/to/my_processing_script.sh "$MYTUBE_VIDEO_PATH"
Security Warning
Warning
Hook commands are executed with the same permissions as the MyTube backend server.
- Be careful when using commands that modify or delete files.
- Do not copy-paste scripts from untrusted sources.
- Ensure your scripts handle errors gracefully.