Univerter/README.md

70 lines
1.9 KiB
Markdown
Raw Normal View History

2023-11-20 15:49:51 -06:00
# Univerter
2023-08-15 09:01:25 -05:00
2024-01-29 08:41:14 -06:00
A web downloader & converter for videos with no client-sided javascript. It can be found at https://yt.violets-purgatory.dev
2023-08-15 09:01:25 -05:00
2024-01-29 08:41:14 -06:00
Currently supports a wide variety of formats and sites, but if you have any other formats you want supported, please open an issue.
Formats added to Univerter must be supported by FFmpeg
Support for sites will only be added if those sites are supported by yt-dlp.
2024-01-11 11:33:16 -06:00
2023-11-20 15:49:51 -06:00
# Installation
2023-11-20 15:49:51 -06:00
There are 2 main ways to install Univerter:
2023-11-20 15:49:51 -06:00
## Docker
2023-11-20 15:49:51 -06:00
The docker image can be found at https://hub.docker.com/r/bingusviolet/univerter
2024-01-29 08:41:14 -06:00
Port 8080 (or whatever you set the environment variable to) is exposed inside the container. It can be exposed with `-p`
2023-11-20 15:49:51 -06:00
Example:
```bash
2023-11-30 20:37:22 -06:00
docker run -p 8080:8080 bingusviolet/univerter
2023-11-20 15:49:51 -06:00
```
2024-01-29 08:41:14 -06:00
This will allow it to be found on port 8080 (E.G. `localhost:8080`)
2024-01-29 08:41:14 -06:00
## Node
2023-08-24 11:00:33 -05:00
1. Clone the repository
```bash
git clone https://github.com/Violets-puragtory/YoutubeConverter
cd YoutubeConverter
```
2023-11-20 15:49:51 -06:00
2. Install Dependancies
2023-11-30 13:33:41 -06:00
- [ffmpeg](https://github.com/FFmpeg/FFmpeg)
- [node](https://github.com/nodejs/node)
- [npm](https://github.com/npm/cli)
2024-01-29 08:41:14 -06:00
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
2023-11-20 15:49:51 -06:00
3. Download NodeJS Dependencies
2023-08-24 11:00:33 -05:00
```bash
npm install
```
2023-11-20 15:52:23 -06:00
## Starting it
2023-08-24 11:00:33 -05:00
```bash
npm start
```
# Environment Variables
2023-11-30 13:22:39 -06:00
`PORT`= [Preffered Port] (8080 if unspecified)
2024-01-29 10:43:28 -06:00
`MAX_FILESIZE` = [Max file size in MB] (Only applies to 1080p>, don't rely on this feature yet though, as it is unfinished.)
# To-Do
2024-01-29 11:06:44 -06:00
- [ ] Advanced options menu
- [ ] Add Subtitles to file
- [ ] Video Searching
- [ ] Video Caching Options
- [ ] Properly cleanup unnessacary files
2024-01-29 10:43:28 -06:00
- [ ] Option to disable 1080p+
- [ ] Option to disable Conversion
- [ ] Proper config
2023-11-30 13:22:39 -06:00
# Instances
Here is a list of all currently public instances. If you want to add your instance to this list, please make an issue or pull request!
2024-01-29 12:58:11 -06:00
- https://univerter.dev (official)
- https://yt.violets-purgatory.dev (official)