weyne/goodtube
1
0
Fork 0
mirror of https://github.com/goodtube4u/goodtube.git synced 2025-11-22 10:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs

Browse Source
This commit is contained in:
goodtube4u
2024-07-28 14:01:37 +10:00
parent 196c0b51ea
commit 1c2cb37382
4 changed files with 104 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
README.md
View File

@@ -166,3 +166,107 @@ I'm dedicated to helping every single user get this working, so really - if you
Many thanks to https://cobalt.tools for providing the amazing API we're using to download stuff!
You can also use this website to download from other platforms like SoundCloud, give it a try :)
## Hosting your own local video server
If you host a local video server, you can make this plugin really fast!
------------------------------------------------------------------------------------------
- This is for advanced users only.
- This is not for phones. You can only do this on a desktop computer (mac, linux, windows - all work).
- Doing this will significantly speed up GoodTube (pretty much to normal loading speed for videos).
Here's how you do it:
------------------------------------------------------------------------------------------
1. Install Docker Desktop (https://www.docker.com/products/docker-desktop/)
2. Install Git (https://git-scm.com/downloads)
3. Open Terminal / Command Prompt and enter the following commands
```
cd c:/
git clone https://github.com/iv-org/invidious.git
```
4. Edit the following file in a text editor like Notepad: c:/invidious/docker-compose.yml
5. Delete all the code in there and replace it with:
```
version: "3"
services:
invidious:
image: quay.io/invidious/invidious:latest
# image: quay.io/invidious/invidious:latest-arm64 # ARM64/AArch64 devices
restart: unless-stopped
ports:
- "127.0.0.1:3000:3000"
environment:
# Please read the following file for a comprehensive list of all available
# configuration options and their associated syntax:
# https://github.com/iv-org/invidious/blob/master/config/config.example.yml
INVIDIOUS_CONFIG: |
db:
dbname: invidious
user: kemal
password: kemal
host: invidious-db
port: 5432
check_tables: true
# external_port:
# domain:
# https_only: false
# statistics_enabled: false
hmac_key: "goodtube4u"
healthcheck:
test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1
interval: 30s
timeout: 5s
retries: 2
logging:
options:
max-size: "1G"
max-file: "4"
depends_on:
- invidious-db
invidious-db:
image: docker.io/library/postgres:14
restart: unless-stopped
volumes:
- postgresdata:/var/lib/postgresql/data
- ./config/sql:/config/sql
- ./docker/init-invidious-db.sh:/docker-entrypoint-initdb.d/init-invidious-db.sh
environment:
POSTGRES_DB: invidious
POSTGRES_USER: kemal
POSTGRES_PASSWORD: kemal
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
volumes:
postgresdata:
```
6. Open Terminal / Command Prompt and enter the following commands
```
cd c:/invidious
docker-compose up
```
7. Let it run for a few minutes, you'll see a bunch of text appearing while it installs everything. Eventually it will stop outputting text and you can close Terminal / Command Prompt.
8. Open Docker Desktop.
9. On the "Containers" tab you will see a thing called "Invidious". Press the play arrow to start it.
10. Check it's working by going to 127.0.0.1:3000 in your browser. If you see an instance of Invidious you're good to go!
11. Now that's done, go to https://www.youtube.com/?goodtube_local=true in your browser to enable the local server. You only need to do this once, the setting will be remembered.
12. Now you can visit Youtube like normal, but at the top of the "Video Source" list you will see a server called "LOCAL". This is your local server.
13. So long as you've got your Invidious instance running in Docker Desktop, then this server will work - and should be SUPER FAST. Enjoy :)
Note: If you want to turn this off, go to https://www.youtube.com/?goodtube_local=false in your browser. You only need to do this once, the setting will be remembered.

97
goodtube.js
View File

@@ -1,100 +1,3 @@
/*
Pro tip - if you host a local video server, you can make this plugin really fast!
------------------------------------------------------------------------------------------
- This is for advanced users only.
- This is not for phones. You can only do this on a desktop computer (mac, linux, windows - all work).
- Doing this will significantly speed up GoodTube (pretty much to normal loading speed for videos).
Here's how you do it:
------------------------------------------------------------------------------------------
1. Install Docker Desktop (https://www.docker.com/products/docker-desktop/)
2. Install Git (https://git-scm.com/downloads)
3. Open Terminal / Command Prompt and enter the following commands
cd c:/
git clone https://github.com/iv-org/invidious.git
4. Edit the following file in a text editor like Notepad: c:/invidious/docker-compose.yml
5. Delete all the code in there and replace it with:
version: "3"
services:
invidious:
image: quay.io/invidious/invidious:latest
# image: quay.io/invidious/invidious:latest-arm64 # ARM64/AArch64 devices
restart: unless-stopped
ports:
- "127.0.0.1:3000:3000"
environment:
# Please read the following file for a comprehensive list of all available
# configuration options and their associated syntax:
# https://github.com/iv-org/invidious/blob/master/config/config.example.yml
INVIDIOUS_CONFIG: |
db:
dbname: invidious
user: kemal
password: kemal
host: invidious-db
port: 5432
check_tables: true
# external_port:
# domain:
# https_only: false
# statistics_enabled: false
hmac_key: "goodtube4u"
healthcheck:
test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1
interval: 30s
timeout: 5s
retries: 2
logging:
options:
max-size: "1G"
max-file: "4"
depends_on:
- invidious-db
invidious-db:
image: docker.io/library/postgres:14
restart: unless-stopped
volumes:
- postgresdata:/var/lib/postgresql/data
- ./config/sql:/config/sql
- ./docker/init-invidious-db.sh:/docker-entrypoint-initdb.d/init-invidious-db.sh
environment:
POSTGRES_DB: invidious
POSTGRES_USER: kemal
POSTGRES_PASSWORD: kemal
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
volumes:
postgresdata:
6. Open Terminal / Command Prompt and enter the following commands
cd c:/invidious
docker-compose up
7. Let it run for a few minutes, you'll see a bunch of text appearing while it installs everything. Eventually it will stop outputting text and you can close Terminal / Command Prompt.
8. Open Docker Desktop.
9. On the "Containers" tab you will see a thing called "Invidious". Press the play arrow to start it.
10. Check it's working by going to 127.0.0.1:3000 in your browser. If you see an instance of Invidious you're good to go!
11. Now that's done, go to https://www.youtube.com/?goodtube_local=true in your browser to enable the local server. You only need to do this once, the setting will be remembered.
12. Now you can visit Youtube like normal, but at the top of the "Video Source" list you will see a server called "LOCAL". This is your local server.
13. So long as you've got your Invidious instance running in Docker Desktop, then this server will work - and should be SUPER FAST. Enjoy :)
Note: If you want to turn this off, go to https://www.youtube.com/?goodtube_local=false in your browser. You only need to do this once, the setting will be remembered.
*/
(function() {
'use strict';

97
goodtube.user.js
View File

@@ -15,103 +15,6 @@
// This now automatically loads the latest version. This means that you will never need to update manually again :)
// To view the full source code go here: https://github.com/goodtube4u/goodtube/blob/main/goodtube.js
/*
Pro tip - if you host a local video server, you can make this plugin really fast!
------------------------------------------------------------------------------------------
- This is for advanced users only.
- This is not for phones. You can only do this on a desktop computer (mac, linux, windows - all work).
- Doing this will significantly speed up GoodTube (pretty much to normal loading speed for videos).
Here's how you do it:
------------------------------------------------------------------------------------------
1. Install Docker Desktop (https://www.docker.com/products/docker-desktop/)
2. Install Git (https://git-scm.com/downloads)
3. Open Terminal / Command Prompt and enter the following commands
cd c:/
git clone https://github.com/iv-org/invidious.git
4. Edit the following file in a text editor like Notepad: c:/invidious/docker-compose.yml
5. Delete all the code in there and replace it with:
version: "3"
services:
invidious:
image: quay.io/invidious/invidious:latest
# image: quay.io/invidious/invidious:latest-arm64 # ARM64/AArch64 devices
restart: unless-stopped
ports:
- "127.0.0.1:3000:3000"
environment:
# Please read the following file for a comprehensive list of all available
# configuration options and their associated syntax:
# https://github.com/iv-org/invidious/blob/master/config/config.example.yml
INVIDIOUS_CONFIG: |
db:
dbname: invidious
user: kemal
password: kemal
host: invidious-db
port: 5432
check_tables: true
# external_port:
# domain:
# https_only: false
# statistics_enabled: false
hmac_key: "goodtube4u"
healthcheck:
test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1
interval: 30s
timeout: 5s
retries: 2
logging:
options:
max-size: "1G"
max-file: "4"
depends_on:
- invidious-db
invidious-db:
image: docker.io/library/postgres:14
restart: unless-stopped
volumes:
- postgresdata:/var/lib/postgresql/data
- ./config/sql:/config/sql
- ./docker/init-invidious-db.sh:/docker-entrypoint-initdb.d/init-invidious-db.sh
environment:
POSTGRES_DB: invidious
POSTGRES_USER: kemal
POSTGRES_PASSWORD: kemal
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
volumes:
postgresdata:
6. Open Terminal / Command Prompt and enter the following commands
cd c:/invidious
docker-compose up
7. Let it run for a few minutes, you'll see a bunch of text appearing while it installs everything. Eventually it will stop outputting text and you can close Terminal / Command Prompt.
8. Open Docker Desktop.
9. On the "Containers" tab you will see a thing called "Invidious". Press the play arrow to start it.
10. Check it's working by going to 127.0.0.1:3000 in your browser. If you see an instance of Invidious you're good to go!
11. Now that's done, go to https://www.youtube.com/?goodtube_local=true in your browser to enable the local server. You only need to do this once, the setting will be remembered.
12. Now you can visit Youtube like normal, but at the top of the "Video Source" list you will see a server called "LOCAL". This is your local server.
13. So long as you've got your Invidious instance running in Docker Desktop, then this server will work - and should be SUPER FAST. Enjoy :)
Note: If you want to turn this off, go to https://www.youtube.com/?goodtube_local=false in your browser. You only need to do this once, the setting will be remembered.
*/
(function() {
'use strict';

97
goodtube.user.min.js vendored
View File

@@ -15,103 +15,6 @@
// This now automatically loads the latest version. This means that you will never need to update manually again :)
// To view the full source code go here: https://github.com/goodtube4u/goodtube/blob/main/goodtube.js
/*
Pro tip - if you host a local video server, you can make this plugin really fast!
------------------------------------------------------------------------------------------
- This is for advanced users only.
- This is not for phones. You can only do this on a desktop computer (mac, linux, windows - all work).
- Doing this will significantly speed up GoodTube (pretty much to normal loading speed for videos).
Here's how you do it:
------------------------------------------------------------------------------------------
1. Install Docker Desktop (https://www.docker.com/products/docker-desktop/)
2. Install Git (https://git-scm.com/downloads)
3. Open Terminal / Command Prompt and enter the following commands
cd c:/
git clone https://github.com/iv-org/invidious.git
4. Edit the following file in a text editor like Notepad: c:/invidious/docker-compose.yml
5. Delete all the code in there and replace it with:
version: "3"
services:
invidious:
image: quay.io/invidious/invidious:latest
# image: quay.io/invidious/invidious:latest-arm64 # ARM64/AArch64 devices
restart: unless-stopped
ports:
- "127.0.0.1:3000:3000"
environment:
# Please read the following file for a comprehensive list of all available
# configuration options and their associated syntax:
# https://github.com/iv-org/invidious/blob/master/config/config.example.yml
INVIDIOUS_CONFIG: |
db:
dbname: invidious
user: kemal
password: kemal
host: invidious-db
port: 5432
check_tables: true
# external_port:
# domain:
# https_only: false
# statistics_enabled: false
hmac_key: "goodtube4u"
healthcheck:
test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1
interval: 30s
timeout: 5s
retries: 2
logging:
options:
max-size: "1G"
max-file: "4"
depends_on:
- invidious-db
invidious-db:
image: docker.io/library/postgres:14
restart: unless-stopped
volumes:
- postgresdata:/var/lib/postgresql/data
- ./config/sql:/config/sql
- ./docker/init-invidious-db.sh:/docker-entrypoint-initdb.d/init-invidious-db.sh
environment:
POSTGRES_DB: invidious
POSTGRES_USER: kemal
POSTGRES_PASSWORD: kemal
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
volumes:
postgresdata:
6. Open Terminal / Command Prompt and enter the following commands
cd c:/invidious
docker-compose up
7. Let it run for a few minutes, you'll see a bunch of text appearing while it installs everything. Eventually it will stop outputting text and you can close Terminal / Command Prompt.
8. Open Docker Desktop.
9. On the "Containers" tab you will see a thing called "Invidious". Press the play arrow to start it.
10. Check it's working by going to 127.0.0.1:3000 in your browser. If you see an instance of Invidious you're good to go!
11. Now that's done, go to https://www.youtube.com/?goodtube_local=true in your browser to enable the local server. You only need to do this once, the setting will be remembered.
12. Now you can visit Youtube like normal, but at the top of the "Video Source" list you will see a server called "LOCAL". This is your local server.
13. So long as you've got your Invidious instance running in Docker Desktop, then this server will work - and should be SUPER FAST. Enjoy :)
Note: If you want to turn this off, go to https://www.youtube.com/?goodtube_local=false in your browser. You only need to do this once, the setting will be remembered.
*/
(function() {
'use strict';