helix
/
invidious
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README reworked

Browse Source
pull/1295/head
Allan Nordhøy 4 years ago committed by GitHub
parent 8ed1c77e47
commit 7422c38e66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 35 deletions
Show Stats Download Patch File Download Diff File

66
README.md
Unescape Escape View File

@ -4,11 +4,9 @@
## Invidious is an alternative front-end to YouTube ## Invidious is an alternative front-end to YouTube
- [Copylefted libre software](https://github.com/omarroth/invidious) (AGPLv3+ licensed)
- Audio-only mode (and no need to keep window open on mobile) - Audio-only mode (and no need to keep window open on mobile)
- [Free software](https://github.com/omarroth/invidious) (AGPLv3 licensed) - Lightweight (the homepage is ~4 KB compressed)
- No ads
- No need to create a Google account to save subscriptions
- Lightweight (homepage is ~4 KB compressed)
- Tools for managing subscriptions: - Tools for managing subscriptions:
- Only show unseen videos - Only show unseen videos
- Only show latest (or latest unseen) video from each channel - Only show latest (or latest unseen) video from each channel
@ -18,11 +16,15 @@
- Dark mode - Dark mode
- Embed support - Embed support
- Set default player options (speed, quality, autoplay, loop) - Set default player options (speed, quality, autoplay, loop)
- Does not require JS to play videos - Support for Reddit comments in place of YouTube comments
- Support for Reddit comments in place of YT comments
- Import/Export subscriptions, watch history, preferences - Import/Export subscriptions, watch history, preferences
- Does not use any of the official YouTube APIs
- Developer [API](https://github.com/omarroth/invidious/wiki/API) - Developer [API](https://github.com/omarroth/invidious/wiki/API)
- 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
Liberapay: https://liberapay.com/omarroth Liberapay: https://liberapay.com/omarroth
BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY BTC: 356DpZyMXu6rYd55Yqzjs29n79kGKWcYrY
@ -30,7 +32,7 @@ BCH: qq4ptclkzej5eza6a50et5ggc58hxsq5aylqut2npk
## Invidious Instances ## Invidious Instances
See [Invidious Instances](https://github.com/omarroth/invidious/wiki/Invidious-Instances) for a full list of publicly available instances. [Here](https://github.com/omarroth/invidious/wiki/Invidious-Instances) you will find a full list of publicly available instances.
### Official Instances ### Official Instances
@ -48,7 +50,7 @@ See [Invidious Instances](https://github.com/omarroth/invidious/wiki/Invidious-I
## Installation ## Installation
See [Invidious-Updater](https://github.com/tmiland/Invidious-Updater) for a self-contained script that can automatically install and update Invidious. [Invidious-Updater](https://github.com/tmiland/Invidious-Updater) is a self-contained script that can automatically install and update Invidious.
### Docker: ### Docker:
@ -58,7 +60,7 @@ See [Invidious-Updater](https://github.com/tmiland/Invidious-Updater) for a self
$ docker-compose up $ docker-compose up
``` ```
And visit `localhost:3000` in your browser. Then visit `localhost:3000` in your browser.
#### Rebuild cluster: #### Rebuild cluster:
@ -75,14 +77,14 @@ $ docker-compose build
### Linux: ### Linux:
#### Install dependencies #### Install the dependencies
```bash ```bash
# Arch Linux # Arch Linux
$ sudo pacman -S base-devel shards crystal librsvg postgresql $ sudo pacman -S base-devel shards crystal librsvg postgresql
# Ubuntu or Debian # Ubuntu or Debian
# First you have to add the repository to your APT configuration. For easy setup just run in your command line: # First you have to add the repository to your APT configuration. For easy setup just run in your command-line:
$ curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash $ 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: # 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 - $ curl -sL "https://keybase.io/crystal/pgp_keys.asc" | sudo apt-key add -
@ -91,7 +93,7 @@ $ sudo apt-get update
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev postgresql librsvg2-bin libsqlite3-dev $ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev postgresql librsvg2-bin libsqlite3-dev
``` ```
#### Add invidious user and clone repository #### Add an Invidious user and clone the repository
```bash ```bash
$ useradd -m invidious $ useradd -m invidious
@ -100,7 +102,7 @@ $ git clone https://github.com/omarroth/invidious
$ exit $ exit
``` ```
#### Setup PostgresSQL #### Set up PostgresSQL
```bash ```bash
$ sudo systemctl enable postgresql $ sudo systemctl enable postgresql
@ -120,7 +122,7 @@ $ psql invidious kemal < /home/invidious/invidious/config/sql/playlist_videos.sq
$ exit $ exit
``` ```
#### Setup Invidious #### Set up Invidious
```bash ```bash
$ sudo -i -u invidious $ sudo -i -u invidious
@ -154,14 +156,14 @@ minsize 1048576
$ sudo chmod 0644 /etc/logrotate.d/invidious.logrotate $ sudo chmod 0644 /etc/logrotate.d/invidious.logrotate
``` ```
### OSX: ### macOS:
```bash ```bash
# Install dependencies # Install dependencies
$ brew update $ brew update
$ brew install shards crystal postgres imagemagick librsvg $ brew install shards crystal postgres imagemagick librsvg
# Clone repository and setup postgres database # Clone the repository and set up a PostgreSQL database
$ git clone https://github.com/omarroth/invidious $ git clone https://github.com/omarroth/invidious
$ cd invidious $ cd invidious
$ brew services start postgresql $ brew services start postgresql
@ -178,14 +180,14 @@ $ psql invidious kemal < config/sql/privacy.sql
$ psql invidious kemal < config/sql/playlists.sql $ psql invidious kemal < config/sql/playlists.sql
$ psql invidious kemal < config/sql/playlist_videos.sql $ psql invidious kemal < config/sql/playlist_videos.sql
# Setup Invidious # Set up Invidious
$ shards update && shards install $ shards update && shards install
$ crystal build src/invidious.cr --release $ crystal build src/invidious.cr --release
``` ```
## Update Invidious ## Update Invidious
You can see how to update Invidious [here](https://github.com/omarroth/invidious/wiki/Updating). [Here](https://github.com/omarroth/invidious/wiki/Updating) is a guide on how to update Invidious.
## Usage: ## Usage:
@ -224,11 +226,11 @@ $ ./sentry
## Made with Invidious ## Made with Invidious
- [FreeTube](https://github.com/FreeTubeApp/FreeTube): An Open Source YouTube app for privacy. - [FreeTube](https://github.com/FreeTubeApp/FreeTube): A libre software YouTube app for privacy.
- [CloudTube](https://cadence.moe/cloudtube/subscriptions): A JS-rich alternate YouTube player - [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. - [PeerTubeify](https://gitlab.com/Cha_deL/peertubeify): On YouTube, displays a link to the same video on PeerTube, if it exists.
- [MusicPiped](https://github.com/deep-gaurav/MusicPiped): A materialistic music player that streams music from YouTube. - [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 frontend. Combined streams & custom YT features. - [LapisTube](https://github.com/blubbll/lapis-tube): A fancy and advanced (experimental) YouTube front-end. Combined streams & custom YT features.
## Contributing ## Contributing
@ -236,20 +238,14 @@ $ ./sentry
2. Create your feature branch (git checkout -b my-new-feature) 2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature') 3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature) 4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request 5. Create a new pull request
## Contact
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. #### Translation
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. - Log in with an account you have elsewhere, or register an account and start translating at [Hosted Weblate](https://hosted.weblate.org/projects/invidious/).
## License ## Contact
[![GNU AGPLv3 Image](https://www.gnu.org/graphics/agplv3-155x51.png)](http://www.gnu.org/licenses/agpl-3.0.en.html) 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.
Invidious is Free Software: You can use, study share and improve it at your 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.
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.

Write Preview
Loading…
Cancel
Save