Univerter/README.md

57 lines
1.5 KiB
Markdown
Raw Normal View History

2023-11-20 15:49:51 -06:00
# Univerter
2023-08-15 09:01:25 -05:00
2023-11-20 15:49:51 -06:00
A web youtube downloader & converter for youtube videos with no client-sided javascript. It can be found at https://yt.violets-purgatory.dev
2023-08-15 09:01:25 -05:00
2023-11-20 15:49:51 -06:00
Currently supports a wide variety of formats, but only supports youtube. If you have any other sites you want supported, or any other formats, please open an issue.
2024-01-11 11:33:16 -06:00
## Announcement
Big changes are planned for Univerter, so updates to the project may slow down! You may see any progress made on the dev branch. (As of writing this that is very little)
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
Port 8080 (or whatever you set the environment variable to) is exposed inside the container. It can be changed with `-p`
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
```
2023-11-30 20:37:22 -06:00
It can now be found on port 8080
2023-11-20 15:49:51 -06:00
## Npm
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)
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)
# 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!
2023-11-30 13:34:25 -06:00
- [yt.violets-purgatory.dev](https://yt.violets-purgatory.dev)