diff --git a/docs/anti-captcha.md b/docs/anti-captcha.md index f60e58e..764c240 100644 --- a/docs/anti-captcha.md +++ b/docs/anti-captcha.md @@ -1,4 +1,4 @@ -# How to setup Anti-Captcha +# Anti-Captcha setup 1. [Register on anti-captcha.com](https://anti-captcha.com/clients/entrance/register) and finish the registration with the link provided in your mailbox. 2. Head over to the [Add fund](https://anti-captcha.com/clients/finance/refill) page and use whatever currency you prefer to use for adding $2 into your balance. diff --git a/docs/apache2.md b/docs/apache2.md index 473ebcb..911610d 100644 --- a/docs/apache2.md +++ b/docs/apache2.md @@ -1,4 +1,4 @@ -# Apache2 Reverse Proxy +# Apache2 reverse proxy setup - A very basic config, secured with Let's Encrypt. Any log is disabled by default. Do not forget to replace `ServerName` with your domain. diff --git a/docs/api/authenticated-endpoints.md b/docs/api/authenticated-endpoints.md index 6efc0b5..dab3b1f 100644 --- a/docs/api/authenticated-endpoints.md +++ b/docs/api/authenticated-endpoints.md @@ -1,4 +1,4 @@ -# Authenticated Endpoints +# API - Authenticated endpoints All endpoints under namespace `/api/v1/auth` require authentication. diff --git a/docs/api/channels_endpoint.md b/docs/api/channels_endpoint.md index a1506d3..2bd4b8d 100644 --- a/docs/api/channels_endpoint.md +++ b/docs/api/channels_endpoint.md @@ -1,4 +1,4 @@ -# Channels endpoint +# API - Channels endpoint Please refer to the [Common object types](./common_types.md) page for more details on the various JSON objects used below. diff --git a/docs/api/common_types.md b/docs/api/common_types.md index d0d344b..994b917 100644 --- a/docs/api/common_types.md +++ b/docs/api/common_types.md @@ -1,4 +1,4 @@ -# Object types used across the API +# API - Common object types ### ImageObject diff --git a/docs/caddy.md b/docs/caddy.md index a082d7a..c4ece41 100644 --- a/docs/caddy.md +++ b/docs/caddy.md @@ -1,4 +1,4 @@ -# Caddy reverse proxy +# Caddy reverse proxy setup This is a very basic config, assuming that you're using Caddy to manage SSL certificates for you. Any log is disabled by default. Do not forget to replace `server_name` with your domain. diff --git a/docs/captcha-bug.md b/docs/captcha-bug.md index f51b7fb..eb80fad 100644 --- a/docs/captcha-bug.md +++ b/docs/captcha-bug.md @@ -1,4 +1,4 @@ -# Issues with CAPTCHA on Debian and Ubuntu +# CAPTCHA bug on Debian and Ubuntu #### Warning: If you use ImageMagick on Ubuntu for other services like Mastodon this guide may break them, please use [this guide](https://linuxconfig.org/how-to-install-imagemagick-7-on-ubuntu-18-04-linux) instead. There is some issue on Debian 9 and Ubuntu 18.04 and later. It appears that the clock (the CAPTCHA) has no hands but you can see them outside the clock. You need to compile ImageMagick yourself with librsvg to solve this issue. diff --git a/docs/db-maintenance.md b/docs/db-maintenance.md index 5eb20c0..1fef950 100644 --- a/docs/db-maintenance.md +++ b/docs/db-maintenance.md @@ -1,4 +1,4 @@ -# Database Information and Maintenance +# Database maintenance !!! Note diff --git a/docs/geoblocking.md b/docs/geoblocking.md index e8f8011..ea9e4a6 100644 --- a/docs/geoblocking.md +++ b/docs/geoblocking.md @@ -1,4 +1,4 @@ -# Geoblocking, available video quality and DASH +# Videos geoblocking ## Geoblocking Sometimes you may notice that you cannot watch a video on Invidious. This is because YouTube is geoblocking, i.e. preventing access to videos based on your geographical location. diff --git a/docs/hide-instance-behind-proxy-server.md b/docs/hide-instance-behind-proxy-server.md index 3108cfe..f781890 100644 --- a/docs/hide-instance-behind-proxy-server.md +++ b/docs/hide-instance-behind-proxy-server.md @@ -1,4 +1,4 @@ -# Hide Invidious instance behind proxy server (for escaping DMCA requests) +# Hiding Invidious instance behind proxy servers (for escaping DMCA requests) This tutorial has been writen by [unixfox](https://github.com/unixfox), owner of [yewtu.be](https://yewtu.be/) diff --git a/docs/index.md b/docs/index.md index 675781a..6704644 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,31 +8,31 @@ ## For Advanced Users - [Preferences](./preferences.md) -- [Using search filters](./search-filters.md) -- [List of URL parameters](./url-parameters.md) -- [Always proxy videos through server](./proxy-videos.md) -- [Geoblocking, available quality and DASH](./geoblocking.md) -- [How to deal with uMatrix](./umatrix.md) -- [Redirector Setup](./redirector-setup.md) +- [Search filters](./search-filters.md) +- [URL parameters](./url-parameters.md) +- [UserScript to always proxy video](./proxy-videos.md) +- [Videos geoblocking](./geoblocking.md) +- [uMatrix setup](./umatrix.md) +- [Redirector setup](./redirector-setup.md) ## For Administrators - [Installation](./installation.md) - [Configuration](./configuration.md) -- [Nginx Reverse Proxy Configuration](./nginx.md) -- [Caddy Reverse Proxy Configuration](./caddy.md) -- [Apache2 Virtual Host with Reverse Proxy](./apache2.md) -- [Database Information and Maintenance](./db-maintenance.md) -- [Takedown Notices](./takedown.md) -- [Hide Invidious instance behind proxy server (for escaping DMCA requests)](./hide-instance-behind-proxy-server.md) -- [Issues with CAPTCHA](./captcha-bug.md) -- [How to setup Anti-Captcha](./anti-captcha.md) -- [How to reset a user's password](./reset-pass.md) +- [NGINX reverse proxy setup](./nginx.md) +- [Caddy reverse proxy setup](./caddy.md) +- [Apache2 reverse proxy setup](./apache2.md) +- [Database maintenance](./db-maintenance.md) +- [Handling takedown notices](./takedown.md) +- [Hiding Invidious instance behind proxy servers (for escaping DMCA requests)](./hide-instance-behind-proxy-server.md) +- [CAPTCHA bug on Debian and Ubuntu](./captcha-bug.md) +- [Anti-Captcha setup](./anti-captcha.md) +- [Reset user password](./reset-password.md) - [Known Exception in log](./known-exception.md) ## For Developers - [API](./api.md) -- [Common object types used across the API](./api/common_types.md) -- ["Channels" endpoint](./api/channels_endpoint.md) -- [Authenticated Endpoints](./api/authenticated-endpoints.md) +- [API - Common object types](./api/common_types.md) +- [API - Channels endpoint](./api/channels_endpoint.md) +- [API - Authenticated endpoints](./api/authenticated-endpoints.md) diff --git a/docs/nginx.md b/docs/nginx.md index 08ce8d3..e327167 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -1,4 +1,4 @@ -# NginX Reverse Proxy +# NGINX reverse proxy setup This is a very basic config, secured with Let's Encrypt. Any log is disabled by default. Do not forget to replace `server_name` with your domain. diff --git a/docs/proxy-videos.md b/docs/proxy-videos.md index 967f295..6fb9d49 100644 --- a/docs/proxy-videos.md +++ b/docs/proxy-videos.md @@ -1,4 +1,4 @@ -# Always use "local" to proxy video through the server without creating an account +# UserScript to always proxy video Download ViolentMonkey for your Browser: [Firefox](https://addons.mozilla.org/en-US/firefox/addon/violentmonkey/) diff --git a/docs/redirector-setup.md b/docs/redirector-setup.md index 9bd71ff..de24237 100644 --- a/docs/redirector-setup.md +++ b/docs/redirector-setup.md @@ -1,4 +1,4 @@ -# Redirector Setup +# Redirector setup # What is Redirector? diff --git a/docs/reset-pass.md b/docs/reset-password.md similarity index 95% rename from docs/reset-pass.md rename to docs/reset-password.md index 541ee1b..8147677 100644 --- a/docs/reset-pass.md +++ b/docs/reset-password.md @@ -1,4 +1,4 @@ -# How to reset a user's password +# Reset user password Resetting a user's invidious password needs you to edit the database. diff --git a/docs/search-filters.md b/docs/search-filters.md index 594df63..b5abdd1 100644 --- a/docs/search-filters.md +++ b/docs/search-filters.md @@ -1,4 +1,4 @@ -# Search operators +# Search filters Invidious supports the various search filters provided by YouTube. diff --git a/docs/takedown.md b/docs/takedown.md index 8f2e067..3d92bfe 100644 --- a/docs/takedown.md +++ b/docs/takedown.md @@ -1,4 +1,4 @@ -# Takedown Notices +# Handling takedown notices If you are running a public Invidious instance, it is very possible that you will end up receiving a takedown notice at some point. A copyright agent will probably search the ID of an infringing video on a search engine and see your instance appear. At least in the United States and in Europe, Invidious instances are, in theory, legal. diff --git a/docs/umatrix.md b/docs/umatrix.md index 4f9d358..5ce7cb4 100644 --- a/docs/umatrix.md +++ b/docs/umatrix.md @@ -1,4 +1,4 @@ -# How to deal with uMatrix +# uMatrix setup If you're using [uMatrix](https://github.com/gorhill/uMatrix), you won't be able to automatically play a video served by Invidious on other websites without unblocking requests to Invidious instances. diff --git a/docs/url-parameters.md b/docs/url-parameters.md index 0144d78..1caf7cd 100644 --- a/docs/url-parameters.md +++ b/docs/url-parameters.md @@ -1,4 +1,4 @@ -# List of URL parameters +# URL parameters A list of URL parameters for Invidious, which can automatically toggle various UI and player settings. diff --git a/mkdocs.yml b/mkdocs.yml index 35ca4f1..243aefc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,7 +32,7 @@ nav: - 'hide-instance-behind-proxy-server.md' - 'captcha-bug.md' - 'anti-captcha.md' - - 'reset-pass.md' + - 'reset-password.md' - 'known-exception.md' - 'For Developers': - 'api.md'