invidious/README.md

105 lines
2.6 KiB
Markdown
Raw Normal View History

2017-11-30 01:12:23 +01:00
# Invidious
2017-11-23 08:48:55 +01:00
2018-08-13 21:20:49 +02:00
## Invidious is what YouTube should be
2017-11-23 08:48:55 +01:00
2018-09-04 04:42:49 +02:00
- Audio-only (and no need to keep window open on mobile)
- [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
- Import/Export subscriptions, watch history, preference
- Does not use any of the official YouTube APIs
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-01-29 03:31:35 +01:00
### Installing [Crystal](https://github.com/crystal-lang/crystal):
2018-07-19 03:09:28 +02:00
#### On Arch:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
$ sudo pacman -S shards crystal
2018-07-19 03:09:28 +02:00
$ shards
2018-01-29 03:31:35 +01:00
```
2018-07-19 03:09:28 +02:00
#### On OSX:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
$ brew update
$ brew install shards crystal-lang
2018-07-19 03:09:28 +02:00
$ shards
2018-01-29 03:31:35 +01:00
```
### Installing Postgres:
2018-07-19 03:25:11 +02:00
#### On Arch:
2018-03-31 16:08:49 +02:00
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL)
2018-01-29 03:58:41 +01:00
2018-07-19 03:09:28 +02:00
#### On OSX:
2018-03-09 17:48:01 +01:00
2018-01-29 03:31:35 +01:00
```bash
$ brew install postgres
```
2018-07-19 03:09:28 +02:00
### Setup Postgres:
2018-03-09 17:48:01 +01:00
2018-01-29 03:58:41 +01:00
```bash
$ ./setup.sh
```
2018-07-19 03:25:11 +02:00
### Installing ImageMagick (required for CAPTCHA):
#### On Arch:
```bash
$ sudo pacman -S imagemagick librsvg
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-07-19 03:09:28 +02:00
$ crystal build src/invidious.cr
$ ./invidious
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)
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