invidious

Version, currently master branch1 version
  • master branchlatestAug 8, 2026

github.com/zoomerville/invidious

Invidious is an alternative front-end to YouTube

1 stars
0 dependents
License: AGPL-3.0-only

Installation

# Add this to your shard.yml
dependencies:
  invidious:
    github: zoomerville/invidious
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 1.10.0, < 2.0.0
License
AGPL-3.0-only
Authors
Invidious team, Contributors!
Target
  • invidious from src/invidious.cr

Dependencies

Runtime Dependencies

  • pg~> 0.28.0github: will/crystal-pg
  • kemal~> 1.6.0github: kemalcr/kemal
  • sqlite3~> 0.21.0github: crystal-lang/crystal-sqlite3
  • protodec~> 0.1.5github: iv-org/protodec
  • http_proxy~> 0.10.3github: mamantoha/http_proxy
  • athena-negotiation~> 0.1.1github: athena-framework/negotiation

Development Dependencies

  • ameba~> 1.6.1github: crystal-ameba/amebadev
  • spectator~> 0.10.4github: icy-arctic-fox/spectatordev

README

Website  •  Instances list  •  FAQ  •  Documentation  •  Contribute  •  Donate

Screenshots

PlayerPreferencesSubscriptions

Features

User features

  • Lightweight
  • No ads
  • No tracking
  • No JavaScript required
  • Light/Dark themes
  • Customizable homepage
  • Subscriptions independent from Google
  • Notifications for all subscribed channels
  • Audio-only mode (with background play on mobile)
  • Support for Reddit comments
  • Available in many languages, thanks to our translators

Data import/export

  • Import subscriptions from YouTube, NewPipe and FreeTube
  • Import watch history from YouTube and NewPipe
  • Export subscriptions to NewPipe and FreeTube
  • Import/Export Invidious user data

Technical features

  • Embedded video support
  • Developer API
  • Does not use official YouTube APIs
  • No Contributor License Agreement (CLA)

Quick start

Repo requires external server configs to run properly. Check external-config-example/ folder

You need to change the socks host,username and password to run properly

Using Invidious:

Hosting Invidious:

Documentation

The full documentation can be accessed online at https://docs.invidious.io/

The documentation's source code is available in this repository: https://github.com/iv-org/documentation

Extensions

We highly recommend the use of Privacy Redirect, a browser extension that automatically redirects YouTube URLs to any Invidious instance and replaces embedded YouTube videos on other websites with Invidious.

The documentation contains a list of browser extensions that we recommended to use along with Invidious.

You can read more here: https://docs.invidious.io/applications/

Contribute

Code

  1. Fork it ( https://github.com/iv-org/invidious/fork ).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Stage your files (git add .).
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin my-new-feature).
  6. Create a new pull request ( https://github.com/iv-org/invidious/compare ).

Translations

We use Weblate to manage Invidious translations.

You can suggest new translations and/or correction here: https://hosted.weblate.org/engage/invidious/.

Creating an account is not required, but recommended, especially if you want to contribute regularly. Weblate also allows you to log-in with major SSO providers like GitHub, GitLab, BitBucket, Google, ...

Projects using Invidious

A list of projects and extensions for or utilizing Invidious can be found in the documentation: https://docs.invidious.io/applications/

Liability

We take no responsibility for the use of our tool, or external instances provided by third parties. We strongly recommend you abide by the valid official regulations in your country. Furthermore, we refuse liability for any inappropriate use of Invidious, such as illegal downloading. This tool is provided to you in the spirit of free, open software.

You may view the LICENSE in which this software is provided to you here.

  1. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.