mirror of
https://github.com/dmunozv04/iSponsorBlockTV.git
synced 2026-01-27 04:40:51 +03:00
Updated Installation (markdown)
@@ -1,47 +1,58 @@
|
||||
# Docker
|
||||
### Setup
|
||||
You need to set up several things before you can run the project.
|
||||
Create blank config file: `touch config.json`
|
||||
Run:
|
||||
```sh
|
||||
## Setup
|
||||
Use one of the configurators to add devices and configure options.
|
||||
|
||||
### 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.
|
||||
```Shell
|
||||
Run it with the following command:
|
||||
```Shell
|
||||
docker run --rm -it \
|
||||
--network=host \
|
||||
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
|
||||
-v /PATH_TO_YOUR_DATA_DIR:/app/data \
|
||||
--net=host \ # Remove line on windows and macOS
|
||||
ghcr.io/dmunozv04/isponsorblocktv \
|
||||
--setup
|
||||
```
|
||||
### Run
|
||||
```sh
|
||||
docker pull ghcr.io/dmunozv04/isponsorblocktv
|
||||
### Using the cli configurator tool:
|
||||
Docker users can run it with the following command:
|
||||
```Shell
|
||||
docker run --rm -it \
|
||||
-v /PATH_TO_YOUR_DATA_DIR:/app/data \
|
||||
ghcr.io/dmunozv04/isponsorblocktv \
|
||||
--setup-cli
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
### Using 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
|
||||
```
|
||||
|
||||
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 \
|
||||
--name iSponsorBlockTV \
|
||||
--restart=unless-stopped \
|
||||
--network=host \
|
||||
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
|
||||
-v /PATH_TO_YOUR_DATA_DIR:/app/data \
|
||||
ghcr.io/dmunozv04/isponsorblocktv
|
||||
```
|
||||
# macOS
|
||||
### Setup
|
||||
Run:
|
||||
```sh
|
||||
mkdir ~/iSponsorBlockTV
|
||||
cd ~/iSponsorBlockTV
|
||||
curl https://github.com/dmunozv04/iSponsorBlockTV/releases/download/v0.1/iSponsorBlockTV-macos -o iSponsorBlockTV
|
||||
chmod +x iSponsorBlockTV
|
||||
./iSponsorBlockTV --macos_install
|
||||
```
|
||||
And follow the steps. This will load the script on login.
|
||||
### Uninstall
|
||||
```sh
|
||||
launchctl unload ~/Library/LaunchAgents/com.dmunozv04.iSponsorBlockTV.plist
|
||||
rm ~/Library/LaunchAgents/com.dmunozv04.iSponsorBlockTV.plist
|
||||
rm -r ~/iSponsorBlockTV
|
||||
```
|
||||
This option is deprecated, use docker instead.
|
||||
# From source
|
||||
### Install
|
||||
## Install
|
||||
You need to install [python](https://www.python.org/downloads/) first, and to make it available in your PATH. After, clone the repo.
|
||||
Then you need to download the dependencies with pip:
|
||||
```python3 -m pip install -r requirements.txt```
|
||||
Lastly, run ```main.py```
|
||||
### Setup
|
||||
## Setup
|
||||
run ```main.py --setup```
|
||||
Reference in New Issue
Block a user