Created Migrate from V1 to V2 (markdown)

David
2023-08-31 15:03:11 +02:00
parent f6862fe10c
commit f55f27b760

39
Migrate-from-V1-to-V2.md Normal file

@@ -0,0 +1,39 @@
You're probably here because you just updated the docker container and realized it's no longer working.
This is because the config file, and the way this application connects to your devices has changed.
## The changes
- iSponsorBlockYT now supports every YouTube TV client, not just the Apple TV one. This means that you can now use this with many other devices, like smart TV's and consoles.
- Your target device and server don't have to be on the same network anymore. This now works over the internet.
- The config file has changed. You will need to update it (you can do it with the help of the new configurator tool)
- A YouTube API key is now only required if you want to use the channel whitelist feature. If you don't want to use it, you can leave it blank.
## How to migrate
## _Warning: you'll need to add ALL your devices again since the method of connecting to them has changed._
### 1.1 Using the new graphical configurator tool:
You can use the graphical setup wizard (powered by [textual](https://github.com/Textualize/textual)).
It will guide you through the process of setting up the new config file.
Docker users can run it with the following command:
```Shell
docker run --rm -it \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
ghcr.io/dmunozv04/isponsorblocktv \
--setup
```
### 1.2 Using the cli configurator tool:
Docker users can run it with the following command:
```Shell
docker run --rm -it \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
ghcr.io/dmunozv04/isponsorblocktv \
--setup-cli
```
### 2 Run the container:
The container doesn't need the `--net=host` flag anymore, so you can run it like this:
```Shell
docker run -d \
--name iSponsorBlockTV \
--restart=unless-stopped \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
ghcr.io/dmunozv04/isponsorblocktv
```