invidious/README.md

217 lines
7.2 KiB
Markdown
Raw Normal View History

2017-11-30 00:12:23 +00:00
# Invidious
2017-11-23 07:48:55 +00:00
2018-09-04 14:22:10 +00:00
## Invidious is an alternative front-end to YouTube
2017-11-23 07:48:55 +00:00
2018-11-19 20:44:24 +00:00
- Audio-only mode (and no need to keep window open on mobile)
2018-09-04 02:42:49 +00: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 14:42:29 +00:00
- Import/Export subscriptions, watch history, preferences
2018-09-04 02:42:49 +00:00
- Does not use any of the official YouTube APIs
2018-11-14 02:38:56 +00:00
- Developer [API](https://github.com/omarroth/invidious/wiki/API)
2018-09-04 02:42:49 +00:00
2018-08-25 20:43:39 +00:00
Liberapay: https://liberapay.com/omarroth
2018-08-13 16:35:46 +00:00
Patreon: https://patreon.com/omarroth
2018-08-13 19:20:49 +00:00
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
2018-08-13 16:35:46 +00:00
2019-01-06 03:51:08 +00:00
Onion links:
- kgg2m7yk5aybusll.onion
- axqzx4s6s54s32yentfqojs3x5i7faxza6xo3ehd4bzzsg2ii4fv2iid.onion
2019-01-24 18:31:56 +00:00
[Alternative Invidious instances](https://github.com/omarroth/invidious/wiki/Invidious-Instances)
2017-11-23 07:48:55 +00:00
## Installation
2018-09-29 15:10:41 +00: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
```
2019-01-23 20:12:02 +00:00
### Linux:
#### Install 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
$ sudo pacman -S shards crystal imagemagick librsvg postgresql
2018-10-31 14:42:29 +00:00
2019-01-23 20:12:02 +00:00
# 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-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
2019-01-23 20:12:02 +00:00
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev librsvg2-dev postgresql imagemagick libsqlite3-dev
```
2018-10-31 14:42:29 +00:00
2019-01-23 20:12:02 +00:00
#### Add invidious user and clone repository
```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
```
2019-01-23 20:12:02 +00:00
#### Setup 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-01-23 20:12:02 +00:00
$ 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-10 18:46:58 +00:00
$ psql invidious < /home/invidious/invidious/config/sql/session_ids.sql
2019-01-23 20:12:02 +00:00
$ psql invidious < /home/invidious/invidious/config/sql/nonces.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
2019-01-23 20:12:02 +00:00
#### Setup Invidious
```bash
$ sudo -i -u invidious
2018-10-31 14:42:29 +00:00
$ cd invidious
2018-07-19 01:09:28 +00:00
$ shards
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
```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
```
2019-01-23 20:12:02 +00:00
### OSX:
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-lang postgres imagemagick librsvg
2018-03-09 16:48:01 +00:00
2019-01-23 20:12:02 +00:00
# Clone repository and setup postgres 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
$ 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-10 18:46:58 +00:00
$ psql invidious < config/sql/session_ids.sql
2019-01-23 20:12:02 +00:00
$ psql invidious < config/sql/nonces.sql
# Setup Invidious
2018-10-31 14:42:29 +00:00
$ shards
$ 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-01-27 17:41:43 +00:00
You can find information about how to update in the wiki: [Updating](https://github.com/omarroth/invidious/wiki/Updating).
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
-t THREADS, --crawl-threads=THREADS
Number of threads for crawling YouTube (default: 0)
2018-09-29 15:10:41 +00:00
-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)
2018-09-29 15:10:41 +00:00
-v THREADS, --video-threads=THREADS
Number of threads for refreshing videos (default: 0)
-o OUTPUT, --output=OUTPUT Redirect output (default: STDOUT)
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
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
[Documentation](https://github.com/omarroth/invidious/wiki) can be found in the wiki.
2018-08-02 20:18:33 +00:00
## Extensions
2019-01-26 18:52:27 +00:00
Extensions for Invidious and for integrating Invidious into other projects [are in the wiki](https://github.com/omarroth/invidious/wiki/Extensions)
2018-08-02 20:18:33 +00:00
2018-12-05 01:22:54 +00:00
## Made with Invidious
2018-12-05 03:28:49 +00:00
- [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.
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)
5. Create a new Pull Request
2017-11-23 07:48:55 +00:00
## Contact
2019-01-21 21:33:25 +00:00
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 07:48:55 +00:00
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.