invidious/README.md

163 lines
4.8 KiB
Markdown
Raw Normal View History

2017-11-30 01:12:23 +01:00
# Invidious
2017-11-23 08:48:55 +01:00
2018-09-04 16:22:10 +02:00
## Invidious is an alternative front-end to YouTube
2017-11-23 08:48:55 +01:00
2018-11-19 21:44:24 +01:00
- Audio-only mode (and no need to keep window open on mobile)
2018-09-04 04:42:49 +02:00
- [Open-source](https://github.com/omarroth/invidious) (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
2018-10-31 15:42:29 +01:00
- Import/Export subscriptions, watch history, preferences
2018-09-04 04:42:49 +02:00
- Does not use any of the official YouTube APIs
2018-11-14 03:38:56 +01:00
- Developer [API](https://github.com/omarroth/invidious/wiki/API)
2018-09-04 04:42:49 +02:00
2018-08-25 22:43:39 +02:00
Liberapay: https://liberapay.com/omarroth
2018-08-13 18:35:46 +02:00
Patreon: https://patreon.com/omarroth
2018-08-13 21:20:49 +02:00
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
2018-08-13 18:35:46 +02:00
2017-11-23 08:48:55 +01:00
## Installation
2018-09-29 17:10:41 +02:00
### Docker:
#### Build and start cluster:
```bash
$ docker-compose up
```
And visit `localhost:3000` in your browser.
#### Rebuild cluster:
```bash
$ docker-compose build
```
#### Delete data and rebuild:
```bash
$ docker volume rm invidious_postgresdata
$ docker-compose build
```
2018-10-31 15:42:29 +01:00
### Arch Linux:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
2018-10-31 15:42:29 +01:00
# 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
2018-07-19 03:09:28 +02:00
$ shards
2018-10-31 15:42:29 +01:00
$ crystal build src/invidious.cr --release
2018-01-29 03:31:35 +01:00
```
2018-10-31 15:42:29 +01:00
### On Ubuntu:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
2018-10-31 15:42:29 +01:00
# 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
2018-07-19 03:09:28 +02:00
$ shards
2018-10-31 15:42:29 +01:00
$ crystal build src/invidious.cr --release
2018-01-29 03:31:35 +01:00
```
2018-10-31 15:42:29 +01:00
### On OSX:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
2018-10-31 15:42:29 +01:00
# Install dependencies
$ brew update
$ brew install shards crystal-lang postgres imagemagick librsvg
2018-03-09 17:48:01 +01:00
2018-10-31 15:42:29 +01:00
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
2018-01-29 03:58:41 +01:00
$ ./setup.sh
2018-10-31 15:42:29 +01:00
$ shards
$ crystal build src/invidious.cr --release
2018-07-19 03:25:11 +02:00
```
2018-01-29 03:31:35 +01:00
## Usage:
2017-11-23 08:52:37 +01:00
```bash
2018-09-29 17:10:41 +02:00
$ 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)
2018-10-31 15:42:29 +01:00
-f THREADS, --feed-threads=THREADS
Number of threads for refreshing feeds (default: 1)
2018-09-29 17:10:41 +02:00
-v THREADS, --video-threads=THREADS
Number of threads for refreshing videos (default: 1)
2017-11-23 08:52:37 +01:00
```
2017-11-23 08:48:55 +01:00
2018-01-29 03:31:35 +01:00
Or for development:
2018-03-09 17:48:01 +01:00
2017-11-23 08:52:37 +01:00
```bash
2018-01-29 03:31:35 +01:00
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
2017-11-23 08:52:37 +01:00
```
2017-11-23 08:48:55 +01:00
2018-08-02 22:18:33 +02:00
## Extensions
- [Alternate Tube Redirector](https://addons.mozilla.org/en-US/firefox/addon/alternate-tube-redirector/): Automatically open Youtube Videos on alternate sites like Invidious or Hooktube.
- [Invidious Redirect](https://greasyfork.org/en/scripts/370461-invidious-redirect): Redirects Youtube URLs to Invidio.us (userscript)
2018-08-03 02:22:33 +02:00
- [Invidio.us embed](https://greasyfork.org/en/scripts/370442-invidious-embed): Replaces YouTube embeds with Invidio.us embeds (userscript)
- [Invidious Downloader](https://github.com/erupete/InvidiousDownloader): Tampermonkey userscript for downloading videos or audio on Invidious (userscript)
2018-08-02 22:18:33 +02:00
2017-11-23 08:48:55 +01:00
## Contributing
2018-03-09 17:48:01 +01:00
1. Fork it ( https://github.com/omarroth/invidious/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
2017-11-23 08:48:55 +01:00
## Contributors
2018-07-19 03:25:11 +02:00
- [omarroth](https://github.com/omarroth) - creator, maintainer