Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tedkulp/vidgrab
Simple web interface to download videos with youtube-dl and store them on your server.
https://github.com/tedkulp/vidgrab
nestjs typescript youtube-dl
Last synced: 2 days ago
JSON representation
Simple web interface to download videos with youtube-dl and store them on your server.
- Host: GitHub
- URL: https://github.com/tedkulp/vidgrab
- Owner: tedkulp
- License: mit
- Created: 2021-07-20T12:38:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-05T15:18:42.000Z (over 1 year ago)
- Last Synced: 2024-11-14T10:41:23.008Z (2 months ago)
- Topics: nestjs, typescript, youtube-dl
- Language: TypeScript
- Homepage: https://hub.docker.com/r/tedkulp/vidgrab
- Size: 832 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Docker Stars Shield](https://img.shields.io/docker/stars/tedkulp/vidgrab.svg?style=flat-square)](https://hub.docker.com/r/tedkulp/vidgrab/)
[![Docker Pulls Shield](https://img.shields.io/docker/pulls/tedkulp/vidgrab.svg?style=flat-square)](https://hub.docker.com/r/tedkulp/vidgrab/)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/tedkulp/vidgrab/master/LICENSE)# Vidgrab
Simple web interface to download videos with [youtube-dl](https://github.com/ytdl-org/youtube-dl) and store them on your server. Written in Typescript using [nest.js](https://nestjs.com).
![screenshot](img/screenshot.png)
## Setup
Vidgrab was written assuming that Docker would be used to deploy it. It requires redis for it's queuing functionality.
### Docker CLI
```shell
docker run -d --name vidgrab -E FILE_DIR=/vidgrab -v /vidgrab:/vidgrab -p 4200:4200 tedkulp/vidgrab
```### Docker Compose
There is an example docker-compose.yml file [included](https://raw.githubusercontent.com/tedkulp/vidgrab/master/docker-compose.yml) in the repo. Use that directly to get a site running on port 3000 or modify to taste.
### Environment Variables
| Name | Default Value | Description |
| ---------- | --------------------- | -------------------------------------- |
| REDIS_HOST | localhost | Hostname of the redis server |
| REDIS_PORT | 6379 | Port to connect to for redis server |
| FILE_DIR | /tmp | Directory to store downloads |
| SITE_URL | http://localhost:4200 | URL to the site. Used for bookmarklet. |## License
This software is available under the [MIT License](https://opensource.org/licenses/MIT).