invidious/README.md

252 lines
10 KiB
Markdown
Raw Normal View History

2017-11-30 00:12:23 +00:00
# Invidious
2017-11-23 07:48:55 +00:00
[![Build Status](https://travis-ci.org/omarroth/invidious.svg?branch=master)](https://travis-ci.org/omarroth/invidious)
2018-09-04 14:22:10 +00:00
## Invidious is an alternative front-end to YouTube
2017-11-23 07:48:55 +00:00
2020-07-13 08:34:22 +00:00
- [Copylefted libre software](https://github.com/omarroth/invidious) (AGPLv3+ licensed)
2018-11-19 20:44:24 +00:00
- Audio-only mode (and no need to keep window open on mobile)
2020-07-13 08:34:22 +00:00
- Lightweight (the homepage is ~4 KB compressed)
2018-09-04 02:42:49 +00:00
- 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)
2020-07-13 08:34:22 +00:00
- Support for Reddit comments in place of YouTube comments
2018-10-31 14:42:29 +00:00
- Import/Export subscriptions, watch history, preferences
2018-11-14 02:38:56 +00:00
- Developer [API](https://github.com/omarroth/invidious/wiki/API)
2020-07-13 08:34:22 +00:00
- Does not use any of the official YouTube APIs
- Does not require JavaScript to play videos
- No need to create a Google account to save subscriptions
- No ads
- No CoC
- No CLA
2018-09-04 02:42:49 +00:00
2018-08-25 20:43:39 +00:00
Liberapay: https://liberapay.com/omarroth
2018-08-13 19:20:49 +00:00
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
2018-08-13 16:35:46 +00:00
2019-06-17 23:10:04 +00:00
## Invidious Instances
2019-01-06 03:51:08 +00:00
2020-07-13 08:34:22 +00:00
[Here](https://github.com/omarroth/invidious/wiki/Invidious-Instances) you will find a full list of publicly available instances.
2019-01-06 03:51:08 +00:00
2019-06-17 23:10:04 +00:00
### Official Instances
- [invidio.us](https://invidio.us) 🇺🇸
Issuer: Let's Encrypt, [SSLLabs Verification](https://www.ssllabs.com/ssltest/analyze.html?d=invidio.us)
- [kgg2m7yk5aybusll.onion](http://kgg2m7yk5aybusll.onion)
- [axqzx4s6s54s32yentfqojs3x5i7faxza6xo3ehd4bzzsg2ii4fv2iid.onion](http://axqzx4s6s54s32yentfqojs3x5i7faxza6xo3ehd4bzzsg2ii4fv2iid.onion)
2019-01-24 18:31:56 +00:00
2019-02-10 13:43:54 +00:00
## Screenshots
2019-02-16 15:51:09 +00:00
| Player | Preferences | Subscriptions |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| [<img src="screenshots/01_player.png?raw=true" height="140" width="280">](screenshots/01_player.png?raw=true) | [<img src="screenshots/02_preferences.png?raw=true" height="140" width="280">](screenshots/02_preferences.png?raw=true) | [<img src="screenshots/03_subscriptions.png?raw=true" height="140" width="280">](screenshots/03_subscriptions.png?raw=true) |
| [<img src="screenshots/04_description.png?raw=true" height="140" width="280">](screenshots/04_description.png?raw=true) | [<img src="screenshots/05_preferences.png?raw=true" height="140" width="280">](screenshots/05_preferences.png?raw=true) | [<img src="screenshots/06_subscriptions.png?raw=true" height="140" width="280">](screenshots/06_subscriptions.png?raw=true) |
2017-11-23 07:48:55 +00:00
## Installation
2020-07-13 08:34:22 +00:00
[Invidious-Updater](https://github.com/tmiland/Invidious-Updater) is a self-contained script that can automatically install and update Invidious.
2019-02-11 16:20:55 +00:00
2018-09-29 15:10:41 +00:00
### Docker:
#### Build and start cluster:
```bash
$ docker-compose up
```
2020-07-13 08:34:22 +00:00
Then visit `localhost:3000` in your browser.
2018-09-29 15:10:41 +00:00
#### Rebuild cluster:
```bash
$ docker-compose build
```
#### Delete data and rebuild:
```bash
$ docker volume rm invidious_postgresdata
$ docker-compose build
```
2019-01-23 20:12:02 +00:00
### Linux:
2020-07-13 08:34:22 +00:00
#### Install the dependencies
2018-03-09 16:48:01 +00:00
2018-01-29 02:31:35 +00:00
```bash
2019-01-23 20:12:02 +00:00
# Arch Linux
2020-01-09 02:00:08 +00:00
$ sudo pacman -S base-devel shards crystal librsvg postgresql
2018-10-31 14:42:29 +00:00
2019-01-23 20:12:02 +00:00
# Ubuntu or Debian
2020-07-13 08:34:22 +00:00
# First you have to add the repository to your APT configuration. For easy setup just run in your command-line:
2019-01-23 20:12:02 +00:00
$ curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash
# That will add the signing key and the repository configuration. If you prefer to do it manually, execute the following commands:
$ curl -sL "https://keybase.io/crystal/pgp_keys.asc" | sudo apt-key add -
$ echo "deb https://dist.crystal-lang.org/apt crystal main" | sudo tee /etc/apt/sources.list.d/crystal.list
$ sudo apt-get update
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev postgresql librsvg2-bin libsqlite3-dev
2019-01-23 20:12:02 +00:00
```
2018-10-31 14:42:29 +00:00
2020-07-13 08:34:22 +00:00
#### Add an Invidious user and clone the repository
2019-01-23 20:12:02 +00:00
```bash
$ useradd -m invidious
$ sudo -i -u invidious
2018-10-31 14:42:29 +00:00
$ git clone https://github.com/omarroth/invidious
2019-01-23 20:12:02 +00:00
$ exit
2018-01-29 02:31:35 +00:00
```
2020-07-13 08:34:22 +00:00
#### Set up PostgresSQL
2018-03-09 16:48:01 +00:00
2018-01-29 02:31:35 +00:00
```bash
2018-10-31 14:42:29 +00:00
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo -i -u postgres
2019-04-06 12:38:33 +00:00
$ psql -c "CREATE USER kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
2019-01-23 20:12:02 +00:00
$ createdb -O kemal invidious
$ psql invidious kemal < /home/invidious/invidious/config/sql/channels.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/videos.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/channel_videos.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/users.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/session_ids.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/nonces.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/annotations.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/playlists.sql
$ psql invidious kemal < /home/invidious/invidious/config/sql/playlist_videos.sql
2018-10-31 14:42:29 +00:00
$ exit
2019-01-23 20:12:02 +00:00
```
2018-10-31 14:42:29 +00:00
2020-07-13 08:34:22 +00:00
#### Set up Invidious
2019-01-23 20:12:02 +00:00
```bash
$ sudo -i -u invidious
2018-10-31 14:42:29 +00:00
$ cd invidious
2019-02-28 19:28:02 +00:00
$ shards update && shards install
2018-10-31 14:42:29 +00:00
$ crystal build src/invidious.cr --release
2019-01-23 20:12:02 +00:00
# test compiled binary
$ ./invidious # stop with ctrl c
$ exit
```
#### systemd service
2019-02-16 15:51:09 +00:00
2019-01-23 20:12:02 +00:00
```bash
2019-01-26 16:12:13 +00:00
$ sudo cp /home/invidious/invidious/invidious.service /etc/systemd/system/invidious.service
2019-01-23 20:12:02 +00:00
$ sudo systemctl enable invidious.service
$ sudo systemctl start invidious.service
2018-01-29 02:31:35 +00:00
```
2020-03-02 15:19:07 +00:00
#### Logrotate
```bash
$ sudo echo "/home/invidious/invidious/invidious.log {
rotate 4
weekly
notifempty
missingok
compress
minsize 1048576
}" | tee /etc/logrotate.d/invidious.logrotate
$ sudo chmod 0644 /etc/logrotate.d/invidious.logrotate
```
2020-07-13 08:34:22 +00:00
### macOS:
2018-03-09 16:48:01 +00:00
2018-01-29 02:31:35 +00:00
```bash
2018-10-31 14:42:29 +00:00
# Install dependencies
$ brew update
$ brew install shards crystal postgres imagemagick librsvg
2018-03-09 16:48:01 +00:00
2020-07-13 08:34:22 +00:00
# Clone the repository and set up a PostgreSQL database
2018-10-31 14:42:29 +00:00
$ git clone https://github.com/omarroth/invidious
$ cd invidious
2019-01-23 20:12:02 +00:00
$ brew services start postgresql
2019-04-06 12:38:33 +00:00
$ psql -c "CREATE ROLE kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
$ createdb -O kemal invidious
$ psql invidious kemal < config/sql/channels.sql
$ psql invidious kemal < config/sql/videos.sql
$ psql invidious kemal < config/sql/channel_videos.sql
$ psql invidious kemal < config/sql/users.sql
$ psql invidious kemal < config/sql/session_ids.sql
$ psql invidious kemal < config/sql/nonces.sql
$ psql invidious kemal < config/sql/annotations.sql
2020-03-01 15:30:55 +00:00
$ psql invidious kemal < config/sql/privacy.sql
$ psql invidious kemal < config/sql/playlists.sql
$ psql invidious kemal < config/sql/playlist_videos.sql
2019-01-23 20:12:02 +00:00
2020-07-13 08:34:22 +00:00
# Set up Invidious
2019-02-28 19:28:02 +00:00
$ shards update && shards install
2018-10-31 14:42:29 +00:00
$ crystal build src/invidious.cr --release
2018-07-19 01:25:11 +00:00
```
2019-01-24 18:31:56 +00:00
## Update Invidious
2019-02-16 15:51:09 +00:00
2020-07-13 08:34:22 +00:00
[Here](https://github.com/omarroth/invidious/wiki/Updating) is a guide on how to update Invidious.
2019-01-24 18:31:56 +00:00
2018-01-29 02:31:35 +00:00
## Usage:
2017-11-23 07:52:37 +00:00
```bash
2018-09-29 15:10:41 +00:00
$ ./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
-c THREADS, --channel-threads=THREADS
Number of threads for refreshing channels (default: 1)
2018-10-31 14:42:29 +00:00
-f THREADS, --feed-threads=THREADS
Number of threads for refreshing feeds (default: 1)
-o OUTPUT, --output=OUTPUT Redirect output (default: STDOUT)
2019-04-06 13:28:53 +00:00
-v, --version Print version
2017-11-23 07:52:37 +00:00
```
2017-11-23 07:48:55 +00:00
2018-01-29 02:31:35 +00:00
Or for development:
2018-03-09 16:48:01 +00:00
2017-11-23 07:52:37 +00:00
```bash
2018-01-29 02:31:35 +00:00
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
2019-04-06 13:28:53 +00:00
🤖 Your SentryBot is vigilant. beep-boop...
2017-11-23 07:52:37 +00:00
```
2017-11-23 07:48:55 +00:00
2019-01-24 18:31:56 +00:00
## Documentation
2019-02-16 15:51:09 +00:00
2019-01-24 18:31:56 +00:00
[Documentation](https://github.com/omarroth/invidious/wiki) can be found in the wiki.
2018-08-02 20:18:33 +00:00
## Extensions
2019-02-16 15:51:09 +00:00
2019-02-11 16:20:55 +00:00
[Extensions](https://github.com/omarroth/invidious/wiki/Extensions) can be found in the wiki, as well as documentation for integrating it into other projects.
2018-08-02 20:18:33 +00:00
2018-12-05 01:22:54 +00:00
## Made with Invidious
2020-07-13 08:34:22 +00:00
- [FreeTube](https://github.com/FreeTubeApp/FreeTube): A libre software YouTube app for privacy.
- [CloudTube](https://cadence.moe/cloudtube/subscriptions): A JavaScript-rich alternate YouTube player
- [PeerTubeify](https://gitlab.com/Cha_deL/peertubeify): On YouTube, displays a link to the same video on PeerTube, if it exists.
2020-07-13 08:34:22 +00:00
- [MusicPiped](https://github.com/deep-gaurav/MusicPiped): A material design music player that streams music from YouTube.
- [LapisTube](https://github.com/blubbll/lapis-tube): A fancy and advanced (experimental) YouTube front-end. Combined streams & custom YT features.
2018-12-05 01:22:54 +00:00
2017-11-23 07:48:55 +00:00
## Contributing
2018-03-09 16:48:01 +00: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)
2020-07-13 08:34:22 +00:00
5. Create a new pull request
2020-07-13 08:34:22 +00:00
#### Translation
2020-07-13 08:34:22 +00:00
- Log in with an account you have elsewhere, or register an account and start translating at [Hosted Weblate](https://hosted.weblate.org/projects/invidious/).
2020-07-13 08:34:22 +00:00
## Contact
2020-07-13 08:34:22 +00:00
Feel free to send an e-mail to omarroth@protonmail.com or join our [Matrix server](https://riot.im/app/#/room/#invidious:matrix.org), or #invidious on freenode.
2017-11-23 07:48:55 +00:00
2020-07-13 08:34:22 +00:00
You can also read the release notes on the [releases](https://github.com/omarroth/invidious/releases) page or in the CHANGELOG.md included in the repository.