Updated Migrate from V1 to V2 (markdown)

David
2023-09-04 12:52:29 +02:00
parent 1a69d52dcc
commit af7308a95f

@@ -5,31 +5,46 @@ This is because the config file, and the way this application connects to your d
- 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)
- The config file has changed location. You will need to update it.
- 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.
- When running this program, you won't be able to view YouTube shorts. This is a limitation made by YouTube, and there's nothing I can do about it.
## How to migrate
### 1 Config file is now stored in `data` directory:
To avoid issues with mounting bare files on docker, and to allow having more files in the future, the config file is now stored in a directory called `data`.
If you're using docker, you'll need to change the path to the config file to `/app/data/config.json`. See below for a full example.
## _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:
### 2.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 \
-v /PATH_TO_YOUR_DATA_DIR:/app/data \
ghcr.io/dmunozv04/isponsorblocktv \
--setup
```
### 1.2 Using the cli configurator tool:
### 2.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 \
-v /PATH_TO_YOUR_DATA_DIR:/app/data \
ghcr.io/dmunozv04/isponsorblocktv \
--setup-cli
```
### 2 Run the container:
### 3.1 Run the container with docker-compose:
```YAML
version: '3.3'
services:
iSponsorBlockTV:
image: ghcr.io/dmunozv04/isponsorblocktv
container_name: iSponsorBlockTV
restart: unless-stopped
volumes:
- /PATH_TO_YOUR_DATA_DIR:/app/data
```
### 3.2 Run the container with docker run:
The container doesn't need the `--net=host` flag anymore, so you can run it like this:
```Shell
docker run -d \
@@ -37,4 +52,4 @@ docker run -d \
--restart=unless-stopped \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
ghcr.io/dmunozv04/isponsorblocktv
```
```