Skip to content

Commit

Permalink
Updated README and screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
yadomi committed Jul 27, 2024
1 parent 6844f6c commit fde301a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,27 @@

![Screenshot of Tube](./screenshot.png)

Tube is a standalone web app that periodically fetches the RSS feeds of selected YouTube channels.
A static `index.html` is created with a chronological view of all the published videos from subscribed channels.
The app doesn't rely on the YouTube API and only uses the RSS feeds of the channels.
The aim is to be simple and straightforward, KISS.

## Docker image

To build the docker image localy:
To build the docker and run image localy:

docker build -t yadomi/tube .
docker run -it -rm --name tube yadomi/tube

Take a look at the compose file for volumes mount and other options.

https://github.com/yadomi/tube/blob/master/docker-compose.yml

and also the list of env variable:

https://github.com/yadomi/tube/blob/65c407ecdeda765b7356a02d34ccc3c54e121dc1/main.ts#L11-L50

## Without docker

To run the app localy without a docker container:

Expand Down
5 changes: 2 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ services:
environment:
- CRON_QUEUE_UPDATE="*/30 * * * *"
volumes:
- ./data:/app/data
- ./public:/app/public
- ./feeds.txt:/app/feeds.txt
- ./data:/app/data # internal data used by Tube (eg: database, user settings ect...)
- ./public:/app/public # public data used by Tube (eg: generated index.html ect...)
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fde301a

Please sign in to comment.