updated readme
This commit is contained in:
Jesse Bannon
parent
07221bfef6
commit
14ecfa89d1
1 changed files with 2 additions and 125 deletions
127
README.md
127
README.md
|
|
@ -245,134 +245,11 @@ player to recognize downloads as:
|
|||
- Local Docker Build
|
||||
|
||||
All installations require a 64-bit CPU. 32-bit is not supported.
|
||||
### Docker Compose
|
||||
The ytdl-sub docker image uses
|
||||
[LinuxServer's](https://www.linuxserver.io/)
|
||||
[base alpine image](https://github.com/linuxserver/docker-baseimage-alpine).
|
||||
It looks, feels, and operates like other LinuxServer images. This is the
|
||||
recommended way to use ytdl-sub.
|
||||
|
||||
The docker image is intended to be used as a console. For automating
|
||||
`subscriptions.yaml` downloads to pull new media, see
|
||||
[this guide](https://github.com/jmbannon/ytdl-sub/wiki/7.-Automate-Downloading-New-Content-Using-Your-Configs)
|
||||
on how set up a cron job in the docker container.
|
||||
```yaml
|
||||
services:
|
||||
ytdl-sub:
|
||||
image: ghcr.io/jmbannon/ytdl-sub:latest
|
||||
container_name: ytdl-sub
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=America/Los_Angeles
|
||||
volumes:
|
||||
- <path/to/ytdl-sub/config>:/config
|
||||
- <path/to/tv_shows>:/tv_shows # optional
|
||||
- <path/to/movies>:/movies # optional
|
||||
- <path/to/music_videos>:/music_videos # optional
|
||||
- <path/to/music>:/music # optional
|
||||
restart: unless-stopped
|
||||
```
|
||||
### Docker CLI
|
||||
```commandline
|
||||
docker run -d \
|
||||
--name=ytdl-sub \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=America/Los_Angeles \
|
||||
-v <path/to/ytdl-sub/config>:/config \
|
||||
-v <OPTIONAL/path/to/tv_shows>:/tv_shows \
|
||||
-v <OPTIONAL/path/to/movies>:/movies \
|
||||
-v <OPTIONAL/path/to/music_videos>:/music_videos \
|
||||
-v <OPTIONAL/path/to/music>:/music \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/jmbannon/ytdl-sub:latest
|
||||
```
|
||||
|
||||
### Windows
|
||||
#### Install ytdl-sub
|
||||
From powershell, run:
|
||||
```commandline
|
||||
curl.exe -L -o ytdl-sub.exe https://github.com/jmbannon/ytdl-sub/releases/latest/download/ytdl-sub.exe
|
||||
ytdl-sub.exe -h
|
||||
```
|
||||
#### Install ffmpeg
|
||||
FFmpeg is a required dependency, and must be in the same directory as ytdl-sub. The commands below downloads
|
||||
[yt-dlp's ffmpeg build](https://github.com/yt-dlp/FFmpeg-Builds) for Windows.
|
||||
```commandline
|
||||
curl.exe -L -o ffmpeg.zip https://github.com/yt-dlp/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-win64-gpl.zip
|
||||
tar -xf ffmpeg.zip
|
||||
move "ffmpeg-master-latest-win64-gpl\bin\ffmpeg.exe" "ffmpeg.exe"
|
||||
move "ffmpeg-master-latest-win64-gpl\bin\ffprobe.exe" "ffprobe.exe"
|
||||
```
|
||||
|
||||
### Linux
|
||||
#### Install ytdl-sub
|
||||
Download and use our executable using the command below.
|
||||
```commandline
|
||||
curl -L -o ytdl-sub https://github.com/jmbannon/ytdl-sub/releases/latest/download/ytdl-sub
|
||||
chmod +x ytdl-sub
|
||||
mv ytdl-sub /usr/bin # May need sudo/root permissions
|
||||
ytdl-sub -h
|
||||
```
|
||||
#### Install ffmpeg
|
||||
FFmpeg is a required dependency. You can install it using your native package
|
||||
manager or download
|
||||
[yt-dlp's ffmpeg build](https://github.com/yt-dlp/FFmpeg-Builds) for Linux using the commands below:
|
||||
```commandline
|
||||
curl -L -o ffmpeg.tar.gz https://github.com/yt-dlp/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-linux64-gpl.tar.xz
|
||||
tar -xf ffmpeg.tar.gz
|
||||
chmod +x ffmpeg-master-latest-linux64-gpl/bin/ffmpeg
|
||||
chmod +x ffmpeg-master-latest-linux64-gpl/bin/ffprobe
|
||||
mv ffmpeg-master-latest-linux64-gpl/bin/ffmpeg.exe /usr/bin/ffmpeg
|
||||
mv ffmpeg-master-latest-linux64-gpl/bin/ffprobe.exe /usr/bin/ffprobe
|
||||
```
|
||||
|
||||
### Linux ARM
|
||||
#### Install ytdl-sub
|
||||
Download and use our executable using the command below.
|
||||
```commandline
|
||||
curl -L -o ytdl-sub https://github.com/jmbannon/ytdl-sub/releases/latest/download/ytdl-sub_aarch64
|
||||
chmod +x ytdl-sub
|
||||
mv ytdl-sub /usr/bin
|
||||
ytdl-sub -h
|
||||
```
|
||||
#### Install ffmpeg
|
||||
FFmpeg is a required dependency. You can install it using your native package
|
||||
manager or download
|
||||
[yt-dlp's ffmpeg build](https://github.com/yt-dlp/FFmpeg-Builds) for Linux using the commands below:
|
||||
```commandline
|
||||
curl -L -o ffmpeg.tar.gz https://github.com/yt-dlp/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-linuxarm64-gpl.tar.xz
|
||||
tar -xf ffmpeg.tar.gz
|
||||
chmod +x ffmpeg-master-latest-linuxarm64-gpl/bin/ffmpeg
|
||||
chmod +x ffmpeg-master-latest-linuxarm64-gpl/bin/ffprobe
|
||||
mv ffmpeg-master-latest-linuxarm64-gpl/bin/ffmpeg.exe /usr/bin/ffmpeg
|
||||
mv ffmpeg-master-latest-linuxarm64-gpl/bin/ffprobe.exe /usr/bin/ffprobe
|
||||
```
|
||||
|
||||
### PIP
|
||||
You can install our [PyPI package](https://pypi.org/project/ytdl-sub/). Both FFmpeg and Python 3.10 or greater are required.
|
||||
```commandline
|
||||
python3 -m pip install -U ytdl-sub
|
||||
```
|
||||
|
||||
### Building Docker Image Locally
|
||||
Run `make docker` in the root directory of this repo to build the image. This
|
||||
will build the python wheel and install it in the Dockerfile.
|
||||
|
||||
### Building Python Package Locally
|
||||
With a Python 3.10 virtual environment, you can clone and install the repo using
|
||||
```commandline
|
||||
git clone https://github.com/jmbannon/ytdl-sub.git
|
||||
cd ytdl-sub
|
||||
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
## Contributing
|
||||
There are many ways to contribute, even without coding. Please take a look in
|
||||
our [GitHub Issues](https://github.com/jmbannon/ytdl-sub/issues) to ask
|
||||
questions, submit a feature request, or pick up a bug.
|
||||
our [GitHub Issues](https://github.com/jmbannon/ytdl-sub/issues) to submit a feature request, or
|
||||
pick up a bug.
|
||||
|
||||
## Support
|
||||
We are pretty active in our
|
||||
|
|
|
|||
Loading…
Reference in a new issue