invidious-experimenting/README.md

231 lines
8.9 KiB
Markdown
Raw Normal View History

2017-11-30 05:42:23 +05:30
# Invidious
2017-11-23 13:18:55 +05:30
2018-09-04 19:52:10 +05:30
## Invidious is an alternative front-end to YouTube
2017-11-23 13:18:55 +05:30
2018-11-20 02:14:24 +05:30
- Audio-only mode (and no need to keep window open on mobile)
2018-09-04 08:12:49 +05:30
- [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 20:12:29 +05:30
- Import/Export subscriptions, watch history, preferences
2018-09-04 08:12:49 +05:30
- Does not use any of the official YouTube APIs
2018-11-14 08:08:56 +05:30
- Developer [API](https://github.com/omarroth/invidious/wiki/API)
2018-09-04 08:12:49 +05:30
2018-08-26 02:13:39 +05:30
Liberapay: https://liberapay.com/omarroth
2018-08-13 22:05:46 +05:30
Patreon: https://patreon.com/omarroth
2018-08-14 00:50:49 +05:30
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
2018-08-13 22:05:46 +05:30
2019-01-06 09:21:08 +05:30
Onion links:
- kgg2m7yk5aybusll.onion
- axqzx4s6s54s32yentfqojs3x5i7faxza6xo3ehd4bzzsg2ii4fv2iid.onion
2019-01-25 00:01:56 +05:30
[Alternative Invidious instances](https://github.com/omarroth/invidious/wiki/Invidious-Instances)
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
2019-02-11 21:50:55 +05:30
See [Invidious-Updater](https://github.com/tmiland/Invidious-Updater) for a self-contained script that can automatically install and update Invidious.
2018-09-29 20:40:41 +05:30
### 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
```
2019-01-24 01:42:02 +05:30
### Linux:
#### Install 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
$ sudo pacman -S shards crystal imagemagick librsvg postgresql
2018-10-31 20:12:29 +05:30
2019-01-24 01:42:02 +05:30
# Ubuntu or Debian
# 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
2019-01-24 01:42:02 +05:30
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev librsvg2-dev postgresql imagemagick libsqlite3-dev
```
2018-10-31 20:12:29 +05:30
2019-01-24 01:42:02 +05:30
#### Add invidious user and clone repository
```bash
$ useradd -m invidious
$ sudo -i -u invidious
2018-10-31 20:12:29 +05:30
$ git clone https://github.com/omarroth/invidious
2019-01-24 01:42:02 +05:30
$ exit
2018-01-29 08:01:35 +05:30
```
2019-01-24 01:42:02 +05:30
#### Setup 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-01-24 01:42:02 +05:30
$ psql -c "CREATE USER kemal WITH PASSWORD 'kemal';"
$ createdb -O kemal invidious
$ psql invidious < /home/invidious/invidious/config/sql/channels.sql
$ psql invidious < /home/invidious/invidious/config/sql/videos.sql
$ psql invidious < /home/invidious/invidious/config/sql/channel_videos.sql
$ psql invidious < /home/invidious/invidious/config/sql/users.sql
2019-02-11 00:16:58 +05:30
$ psql invidious < /home/invidious/invidious/config/sql/session_ids.sql
2019-01-24 01:42:02 +05:30
$ psql invidious < /home/invidious/invidious/config/sql/nonces.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
2019-01-24 01:42:02 +05:30
#### Setup Invidious
```bash
$ sudo -i -u invidious
2018-10-31 20:12:29 +05:30
$ cd invidious
2018-07-19 06:39:28 +05:30
$ shards
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
```
2019-01-24 01:42:02 +05:30
### OSX:
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-lang postgres imagemagick librsvg
2018-03-09 22:18:01 +05:30
2019-01-24 01:42:02 +05:30
# Clone repository and setup postgres database
2018-10-31 20:12:29 +05:30
$ git clone https://github.com/omarroth/invidious
$ cd invidious
2019-01-24 01:42:02 +05:30
$ brew services start postgresql
$ psql -c "CREATE ROLE kemal WITH LOGIN PASSWORD 'kemal';"
$ createdb invidious -U kemal
$ psql invidious < config/sql/channels.sql
$ psql invidious < config/sql/videos.sql
$ psql invidious < config/sql/channel_videos.sql
$ psql invidious < config/sql/users.sql
2019-02-11 00:16:58 +05:30
$ psql invidious < config/sql/session_ids.sql
2019-01-24 01:42:02 +05:30
$ psql invidious < config/sql/nonces.sql
# Setup Invidious
2018-10-31 20:12:29 +05:30
$ shards
$ crystal build src/invidious.cr --release
2018-07-19 06:55:11 +05:30
```
2019-01-25 00:01:56 +05:30
## Update Invidious
2019-02-16 21:21:09 +05:30
2019-02-11 21:50:55 +05:30
You can see how to update Invidious [here](https://github.com/omarroth/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
-t THREADS, --crawl-threads=THREADS
Number of threads for crawling YouTube (default: 0)
2018-09-29 20:40:41 +05:30
-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)
2018-09-29 20:40:41 +05:30
-v THREADS, --video-threads=THREADS
Number of threads for refreshing videos (default: 0)
-o OUTPUT, --output=OUTPUT Redirect output (default: STDOUT)
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
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
2019-01-25 00:01:56 +05:30
[Documentation](https://github.com/omarroth/invidious/wiki) can be found in the wiki.
2018-08-03 01:48:33 +05:30
## Extensions
2019-02-16 21:21:09 +05:30
2019-02-11 21:50:55 +05:30
[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-03 01:48:33 +05:30
2018-12-05 06:52:54 +05:30
## Made with Invidious
2018-12-05 08:58:49 +05:30
- [FreeTube](https://github.com/FreeTubeApp/FreeTube): An Open Source YouTube app for privacy.
- [CloudTube](https://github.com/cloudrac3r/cadencegq): Website featuring pastebin, image host, and YouTube player
- [PeerTubeify](https://gitlab.com/Ealhad/peertubeify): On YouTube, displays a link to the same video on PeerTube, if it exists.
2019-02-11 02:36:44 +05:30
- [MusicPiped](https://github.com/deep-gaurav/MusicPiped): A materialistic music player that streams music from YouTube.
2018-12-05 06:52:54 +05:30
2017-11-23 13:18:55 +05:30
## Contributing
2018-03-09 22:18:01 +05:30
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 13:18:55 +05:30
## Contact
2019-01-22 03:03:25 +05:30
Feel free to send an email to omarroth@protonmail.com or join our [Matrix Server](https://riot.im/app/#/room/#invidious:matrix.org), or #invidious on Freenode.
You can also view release notes on the [releases](https://github.com/omarroth/invidious/releases) page or in the CHANGELOG.md included in the repository.
## License
[![GNU AGPLv3 Image](https://www.gnu.org/graphics/agplv3-155x51.png)](http://www.gnu.org/licenses/agpl-3.0.en.html)
2017-11-23 13:18:55 +05:30
Invidious is Free Software: You can use, study share and improve it at your
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU Affero General Public License](https://www.gnu.org/licenses/agpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.