Removed recommendation of nightly, updated language in README, and updated SECURITY.md

pull/657/head
Isaac Abadi 3 years ago
parent da8c23d3ef
commit 9d1624d569

@ -1,2 +1,2 @@
FROM tzahi12345/youtubedl-material:nightly FROM tzahi12345/youtubedl-material:latest
CMD [ "pm2-runtime", "pm2.config.js" ] CMD [ "pm2-runtime", "pm2.config.js" ]

@ -12,16 +12,6 @@ Now with [Docker](#Docker) support!
<hr> <hr>
### USAGE OF THE NIGHTLY BUILDS IS HIGHLY RECOMMENDED.
For much better scaling with large datasets please run your YTDL-M instance with a MongoDB backend rather than the json file-based default.
It will fix a lot of performance problems (especially with datasets in the tens of thousands videos/audios)!
The (closed) issues as well as the project's Wiki will give you good starting points for your journey!
For MongoDB specifically there is [this little guide](https://github.com/Tzahi12345/YoutubeDL-Material/wiki/Setting-a-MongoDB-backend-to-use-as-database-provider-for-YTDL-M).
<hr>
## Getting Started ## Getting Started
Check out the prerequisites, and go to the installation section. Easy as pie! Check out the prerequisites, and go to the installation section. Easy as pie!
@ -58,6 +48,7 @@ sudo yum install nodejs youtube-dl ffmpeg ffmpeg-devel
Optional dependencies: Optional dependencies:
* AtomicParsley (for embedding thumbnails, package name `atomicparsley`) * AtomicParsley (for embedding thumbnails, package name `atomicparsley`)
* [tcd](https://github.com/PetterKraabol/Twitch-Chat-Downloader) (for downloading Twitch VOD chats)
### Installing ### Installing
@ -102,8 +93,6 @@ If you are looking to setup YoutubeDL-Material with Docker, this section is for
3. Run `docker-compose up` to start it up. If successful, it should say "HTTP(S): Started on port 17443" or something similar. This tells you the *container-internal* port of the application. Please check your `docker-compose.yml` file for the *external* port. If you downloaded the file as described above, it defaults to **8998**. 3. Run `docker-compose up` to start it up. If successful, it should say "HTTP(S): Started on port 17443" or something similar. This tells you the *container-internal* port of the application. Please check your `docker-compose.yml` file for the *external* port. If you downloaded the file as described above, it defaults to **8998**.
4. Make sure you can connect to the specified URL + *external* port, and if so, you are done! 4. Make sure you can connect to the specified URL + *external* port, and if so, you are done!
NOTE: It is currently recommended that you use the `nightly` tag on Docker. To do so, simply update the docker-compose.yml `image` field so that it points to `tzahi12345/youtubedl-material:nightly`.
### Custom UID/GID ### Custom UID/GID
By default, the Docker container runs as non-root with UID=1000 and GID=1000. To set this to your own UID/GID, simply update the `environment` section in your `docker-compose.yml` like so: By default, the Docker container runs as non-root with UID=1000 and GID=1000. To set this to your own UID/GID, simply update the `environment` section in your `docker-compose.yml` like so:
@ -114,6 +103,12 @@ environment:
GID: YOUR_GID GID: YOUR_GID
``` ```
## MongoDB
For much better scaling with large datasets please run your YoutubeDL-Material instance with MongoDB backend rather than the json file-based default. It will fix a lot of performance problems (especially with datasets in the tens of thousands videos/audios)!
[Tutorial](https://github.com/Tzahi12345/YoutubeDL-Material/wiki/Setting-a-MongoDB-backend-to-use-as-database-provider-for-YTDL-M).
## API ## API
[API Docs](https://youtubedl-material.stoplight.io/docs/youtubedl-material/Public%20API%20v1.yaml) [API Docs](https://youtubedl-material.stoplight.io/docs/youtubedl-material/Public%20API%20v1.yaml)

@ -2,16 +2,16 @@
## Supported Versions ## Supported Versions
Currently all work on this project goes into the nightly builds. If you would like to see the latest updates, use the `nightly` tag on Docker.
4.2's RELEASE build is now quite old and should be considered legacy.
We urge users to use the nightly releases, because the project
constantly sees fixes.
| Version | Supported | If you'd like to stick with more stable releases, use the `latest` tag on Docker or download the [latest release here](https://github.com/Tzahi12345/YoutubeDL-Material/releases/latest).
| ------------- | ------------------ |
| 4.2 Nightlies | :white_check_mark: | | Version | Supported |
| 4.2 Release | :x: | | -------------------- | ------------------ |
| < 4.2 | :x: | | 4.3 Docker Nightlies | :white_check_mark: |
| 4.3 Release | :white_check_mark: |
| 4.2 Release | :x: |
| < 4.2 | :x: |
## Reporting a Vulnerability ## Reporting a Vulnerability

@ -17,7 +17,7 @@ services:
- ./users:/app/users - ./users:/app/users
ports: ports:
- "8998:17442" - "8998:17442"
image: tzahi12345/youtubedl-material:nightly image: tzahi12345/youtubedl-material:latest
ytdl-mongo-db: ytdl-mongo-db:
image: mongo image: mongo
ports: ports:

Loading…
Cancel
Save