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

Updated Installation (markdown)

David
2023-10-13 20:02:56 +02:00
parent 69935e53fa
commit 58ebc300ee
1 changed files with 41 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
Installation.md

@@ -1,47 +1,58 @@
# Docker # Docker
### Setup ## Setup
You need to set up several things before you can run the project. Use one of the configurators to add devices and configure options.
Create blank config file: `touch config.json`
Run: ### Using the new graphical configurator tool:
```sh 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 \ docker run --rm -it \
--network=host \ -v /PATH_TO_YOUR_DATA_DIR:/app/data \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \ --net=host \ # Remove line on windows and macOS
ghcr.io/dmunozv04/isponsorblocktv \ ghcr.io/dmunozv04/isponsorblocktv \
--setup --setup
``` ```
### Run ### Using the cli configurator tool:
```sh Docker users can run it with the following command:
docker pull ghcr.io/dmunozv04/isponsorblocktv ```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 \ docker run -d \
--name iSponsorBlockTV \ --name iSponsorBlockTV \
--restart=unless-stopped \ --restart=unless-stopped \
--network=host \ -v /PATH_TO_YOUR_DATA_DIR:/app/data \
-v /PATH_TO_YOUR_CONFIG.json:/app/config.json \
ghcr.io/dmunozv04/isponsorblocktv ghcr.io/dmunozv04/isponsorblocktv
``` ```
# macOS # macOS
### Setup This option is deprecated, use docker instead.
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
```
# From source # 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. 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: Then you need to download the dependencies with pip:
```python3 -m pip install -r requirements.txt``` ```python3 -m pip install -r requirements.txt```
Lastly, run ```main.py``` Lastly, run ```main.py```
### Setup ## Setup
run ```main.py --setup``` run ```main.py --setup```