mirror of https://github.com/iv-org/invidious.git
0c8a1d46bd | ||
---|---|---|
assets | ||
config | ||
docker | ||
src | ||
.editorconfig | ||
.gitignore | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
docker-compose.yml | ||
setup.sh | ||
shard.yml |
README.md
Invidious
Invidious is an alternative front-end to YouTube
- Audio-only (and no need to keep window open on mobile)
- Open-source (AGPLv3 licensed)
- No ads
- No need to create a Google account to save subscriptions
- Lightweight (homepage is ~4 KB compressed)
- Tools for managing subscriptions:
- Only show unseen videos
- Only show latest (or latest unseen) video from each channel
- Delivers notifications from all subscribed channels
- Automatically redirect homepage to feed
- Import subscriptions from YouTube
- Dark mode
- Embed support
- Set default player options (speed, quality, autoplay, loop)
- Does not require JS to play videos
- Support for Reddit comments in place of YT comments
- Import/Export subscriptions, watch history, preferences
- Does not use any of the official YouTube APIs
Liberapay: https://liberapay.com/omarroth
Patreon: https://patreon.com/omarroth
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
Installation
Docker:
Build and start cluster:
$ docker-compose up
And visit localhost:3000
in your browser.
Rebuild cluster:
$ docker-compose build
Delete data and rebuild:
$ docker volume rm invidious_postgresdata
$ docker-compose build
Arch Linux:
# Install dependencies
$ sudo pacman -S shards crystal imagemagick librsvg
# Setup PostgresSQL
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo -i -u postgres
$ createuser -s YOUR_USER_NAME
$ createdb YOUR_USER_NAME
$ exit
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
$ ./setup.sh
$ shards
$ crystal build src/invidious.cr --release
On Ubuntu:
# Install dependencies
$ curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash
$ sudo apt update
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev librsvg2-dev postgresql imagemagick
# Setup PostgreSQL
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo -i -u postgres
$ createuser -s YOUR_USER_NAME_HERE
$ createdb YOUR_USER_NAME_HERE
$ exit
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
$ ./setup.sh
$ shards
$ crystal build src/invidious.cr --release
On OSX:
# Install dependencies
$ brew update
$ brew install shards crystal-lang postgres imagemagick librsvg
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
$ ./setup.sh
$ shards
$ crystal build src/invidious.cr --release
Usage:
$ crystal build src/invidious.cr --release
$ ./invidious -h
Usage: invidious [arguments]
-b HOST, --bind HOST Host to bind (defaults to 0.0.0.0)
-p PORT, --port PORT Port to listen for connections (defaults to 3000)
-s, --ssl Enables SSL
--ssl-key-file FILE SSL key file
--ssl-cert-file FILE SSL certificate file
-h, --help Shows this help
-t THREADS, --crawl-threads=THREADS
Number of threads for crawling (default: 1)
-c THREADS, --channel-threads=THREADS
Number of threads for refreshing channels (default: 1)
-f THREADS, --feed-threads=THREADS
Number of threads for refreshing feeds (default: 1)
-v THREADS, --video-threads=THREADS
Number of threads for refreshing videos (default: 1)
Or for development:
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
Extensions
- Alternate Tube Redirector: Automatically open Youtube Videos on alternate sites like Invidious or Hooktube.
- Invidious Redirect: Redirects Youtube URLs to Invidio.us (userscript)
- Invidio.us embed: Replaces YouTube embeds with Invidio.us embeds (userscript)
- Invidious Downloader: Tampermonkey userscript for downloading videos or audio on Invidious (userscript)
Contributing
- Fork it ( https://github.com/omarroth/invidious/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
- omarroth - creator, maintainer