invidious/README.md

269 lines
10 KiB
Markdown
Raw Normal View History

2017-11-30 05:42:23 +05:30
# Invidious
2017-11-23 13:18:55 +05:30
2020-08-13 11:42:40 +05:30
[![Build Status](https://travis-ci.org/iv-org/invidious.svg?branch=master)](https://travis-ci.org/github/iv-org/invidious)
2018-09-04 19:52:10 +05:30
## Invidious is an alternative front-end to YouTube
2017-11-23 13:18:55 +05:30
## Invidious Instances
[Public Invidious instances are listed here.](https://github.com/iv-org/invidious/wiki/Invidious-Instances)
## Invidious Features
- [Copylefted libre software](https://github.com/iv-org/invidious) (AGPLv3+ licensed)
2018-11-20 02:14:24 +05:30
- Audio-only mode (and no need to keep window open on mobile)
2020-07-13 14:04:22 +05:30
- Lightweight (the homepage is ~4 KB compressed)
2018-09-04 08:12:49 +05:30
- 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 14:04:22 +05:30
- Support for Reddit comments in place of YouTube comments
2018-10-31 20:12:29 +05:30
- Import/Export subscriptions, watch history, preferences
- [Developer API](https://github.com/iv-org/invidious/wiki/API)
2020-07-13 14:04:22 +05:30
- 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 08:12:49 +05:30
Liberapay: https://liberapay.com/iv-org/
2018-08-13 22:05:46 +05:30
2019-01-06 09:21:08 +05:30
2019-01-25 00:01:56 +05:30
2019-02-10 19:13:54 +05:30
## Screenshots
2019-02-16 21:21:09 +05:30
| 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 13:18:55 +05:30
## Installation
To manually compile invidious you need at least 2GB of RAM. If you have less you can setup SWAP to have a combined amount of 2 GB or use Docker instead.
After installation take a look at the [Post-install steps](#post-install).
### Automated:
2020-07-13 14:04:22 +05:30
[Invidious-Updater](https://github.com/tmiland/Invidious-Updater) is a self-contained script that can automatically install and update Invidious.
2019-02-11 21:50:55 +05:30
2018-09-29 20:40:41 +05:30
### Docker:
#### Build and start cluster:
```bash
$ docker-compose up
```
2020-07-13 14:04:22 +05:30
Then visit `localhost:3000` in your browser.
2018-09-29 20:40:41 +05:30
#### Rebuild cluster:
```bash
$ docker-compose build
```
#### Delete data and rebuild:
```bash
$ docker volume rm invidious_postgresdata
$ docker-compose build
```
### Manually:
2020-06-06 07:42:43 +05:30
### Linux:
2019-01-24 01:42:02 +05:30
2020-07-13 14:04:22 +05:30
#### Install the dependencies
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
2019-01-24 01:42:02 +05:30
# Arch Linux
2020-01-09 07:30:08 +05:30
$ sudo pacman -S base-devel shards crystal librsvg postgresql
2018-10-31 20:12:29 +05:30
2019-01-24 01:42:02 +05:30
# Ubuntu or Debian
2020-07-13 16:52:01 +05:30
# First you have to add the repository to your APT configuration. For easy setup just run in your command line:
2019-01-24 01:42:02 +05:30
$ 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
2020-09-28 00:47:52 +05:30
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev postgresql librsvg2-bin libsqlite3-dev zlib1g-dev
2019-01-24 01:42:02 +05:30
```
2018-10-31 20:12:29 +05:30
2020-07-13 14:04:22 +05:30
#### Add an Invidious user and clone the repository
2019-01-24 01:42:02 +05:30
```bash
$ useradd -m invidious
$ sudo -i -u invidious
$ git clone https://github.com/iv-org/invidious
2019-01-24 01:42:02 +05:30
$ exit
2018-01-29 08:01:35 +05:30
```
2020-07-13 14:04:22 +05:30
#### Set up PostgresSQL
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
2018-10-31 20:12:29 +05:30
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo -i -u postgres
2019-04-06 18:08:33 +05:30
$ psql -c "CREATE USER kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
2019-01-24 01:42:02 +05:30
$ 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 20:12:29 +05:30
$ exit
2019-01-24 01:42:02 +05:30
```
2018-10-31 20:12:29 +05:30
2020-07-13 14:04:22 +05:30
#### Set up Invidious
2019-01-24 01:42:02 +05:30
```bash
$ sudo -i -u invidious
2018-10-31 20:12:29 +05:30
$ cd invidious
2019-03-01 00:58:02 +05:30
$ shards update && shards install
2018-10-31 20:12:29 +05:30
$ crystal build src/invidious.cr --release
2019-01-24 01:42:02 +05:30
# test compiled binary
$ ./invidious # stop with ctrl c
$ exit
```
#### systemd service
2019-02-16 21:21:09 +05:30
2019-01-24 01:42:02 +05:30
```bash
2019-01-26 21:42:13 +05:30
$ sudo cp /home/invidious/invidious/invidious.service /etc/systemd/system/invidious.service
2019-01-24 01:42:02 +05:30
$ sudo systemctl enable invidious.service
$ sudo systemctl start invidious.service
2018-01-29 08:01:35 +05:30
```
2020-03-02 20:49:07 +05:30
#### 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
```
### MacOS:
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
2018-10-31 20:12:29 +05:30
# Install dependencies
$ brew update
$ brew install shards crystal postgres imagemagick librsvg
2018-03-09 22:18:01 +05:30
2020-07-13 14:04:22 +05:30
# Clone the repository and set up a PostgreSQL database
$ git clone https://github.com/iv-org/invidious
2018-10-31 20:12:29 +05:30
$ cd invidious
2019-01-24 01:42:02 +05:30
$ brew services start postgresql
2019-04-06 18:08:33 +05:30
$ 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 21:00:55 +05:30
$ psql invidious kemal < config/sql/privacy.sql
$ psql invidious kemal < config/sql/playlists.sql
$ psql invidious kemal < config/sql/playlist_videos.sql
2019-01-24 01:42:02 +05:30
2020-07-13 14:04:22 +05:30
# Set up Invidious
2019-03-01 00:58:02 +05:30
$ shards update && shards install
2018-10-31 20:12:29 +05:30
$ crystal build src/invidious.cr --release
2018-07-19 06:55:11 +05:30
```
## Post-install:
Detailled configuration available in the [configuration guide](https://github.com/iv-org/invidious/wiki/Configuration).
If you use a reverse proxy, you **must** to configure invidious to properly serve request through it:
`https_only: true` : if your are serving your instance via https, set it to true
`domain: domain.ext`: if you have are serving your instance via a domain name, set it here
`external_port: 443`: if your are serving your instance via https, set it to 443
2019-01-25 00:01:56 +05:30
## Update Invidious
2019-02-16 21:21:09 +05:30
Instructions are available in the [updating guide](https://github.com/iv-org/invidious/wiki/Updating).
2019-01-25 00:01:56 +05:30
2018-01-29 08:01:35 +05:30
## Usage:
2017-11-23 13:22:37 +05:30
```bash
2018-09-29 20:40:41 +05:30
$ ./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 20:12:29 +05:30
-f THREADS, --feed-threads=THREADS
Number of threads for refreshing feeds (default: 1)
-o OUTPUT, --output=OUTPUT Redirect output (default: STDOUT)
2019-04-06 18:58:53 +05:30
-v, --version Print version
2017-11-23 13:22:37 +05:30
```
2017-11-23 13:18:55 +05:30
2018-01-29 08:01:35 +05:30
Or for development:
2018-03-09 22:18:01 +05:30
2017-11-23 13:22:37 +05:30
```bash
2018-01-29 08:01:35 +05:30
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
2019-04-06 18:58:53 +05:30
🤖 Your SentryBot is vigilant. beep-boop...
2017-11-23 13:22:37 +05:30
```
2017-11-23 13:18:55 +05:30
2019-01-25 00:01:56 +05:30
## Documentation
2019-02-16 21:21:09 +05:30
[Documentation](https://github.com/iv-org/invidious/wiki) can be found in the wiki.
2019-01-25 00:01:56 +05:30
2018-08-03 01:48:33 +05:30
## Extensions
2019-02-16 21:21:09 +05:30
[Extensions](https://github.com/iv-org/invidious/wiki/Extensions) can be found in the wiki, as well as documentation for integrating it into other projects.
2018-08-03 01:48:33 +05:30
2018-12-05 06:52:54 +05:30
## Made with Invidious
2020-07-13 14:04:22 +05:30
- [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 14:04:22 +05:30
- [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.
- [HoloPlay](https://github.com/stephane-r/HoloPlay): Funny Android application connecting on Invidious API's with search, playlists and favoris.
2018-12-05 06:52:54 +05:30
2017-11-23 13:18:55 +05:30
## Contributing
1. Fork it ( https://github.com/iv-org/invidious/fork )
2018-03-09 22:18:01 +05:30
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 14:04:22 +05:30
5. Create a new pull request
2020-07-13 14:04:22 +05:30
#### Translation
2020-07-13 14:04:22 +05:30
- 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 14:04:22 +05:30
## Contact
2020-07-13 14:04:22 +05:30
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 13:18:55 +05:30
You can also read the release notes on the [page of releases](https://github.com/iv-org/invidious/releases) [CHANGELOG.md](https://github.com/iv-org/invidious/blob/master/CHANGELOG.md) included in the repository.