Mirror/iSponsorBlockTV
1
0
Fork 0
mirror of https://github.com/dmunozv04/iSponsorBlockTV.git synced 2026-01-27 04:40:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarifying the installation steps for new users.

mgrimace
2023-10-18 15:48:39 -04:00
parent f10e65a645
commit f1512632cd
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Installation.md

@@ -1,8 +1,11 @@
# Docker
## Setup
Use one of the configurators to add devices and configure options.
### Using the new graphical configurator tool:
There are two basic steps to install iSponsorBlockTV using Docker. Step 1 involves creating a config.yml file using the graphical configuation or command-line tools. Step 2 involves creating and running the service via docker compose or run. In both steps, you will need to enter the pathway to your iSponsorBlockTV data directory. Alternatively, you can install iSponsorBlock from the source.
## Step 1: Create a config file
Choose one of the following configurators to add devices and configure options.
### Option 1: Using the new graphical configurator tool:
You can use the graphical setup wizard (powered by [textual](https://github.com/Textualize/textual)).
If you want to auto discover your device, you need to run the container with the `--net=host` flag. This only works on linux.
@@ -15,7 +18,7 @@ docker run --rm -it \
ghcr.io/dmunozv04/isponsorblocktv \
--setup
```
### Using the text-based cli configurator tool:
### Option 2: Using the text-based cli configurator tool:
This is a great option if you experience issues with the graphical configurator
Docker users can run it with the following command:
```Shell
@@ -24,10 +27,11 @@ docker run --rm -it \
ghcr.io/dmunozv04/isponsorblocktv \
--setup-cli
```
Note, the CLI will ask you for a TV Link Code. You can find this on your Device's Youtube app, by going to Settings.
## Run
## Step 2: Install and run the iSponsorBlockTV Docker service
### Using docker-compose
### Option 1: Using docker-compose
```YAML
version: '3.3'
services:
@@ -36,8 +40,11 @@ services:
container_name: iSponsorBlockTV
restart: unless-stopped
volumes:
- /PATH_TO_YOUR_DATA_DIR:/app/data
- /PATH_TO_YOUR_DATA_DIR:/app/data #enter the same pathway as you used for your configurator in step 1
```
Then use `docker compose up -d` to start.
### Option 2: Using docker run
Run the container with docker run:
The container doesn't need the `--net=host` flag anymore, so you can run it like this: