PlugArr

https://github.com/yannickuhrig1/plugarr
Admin
PlugArr is an automated deployment and configuration tool that sets up and seamlessly interconnects...
Tokens:167,291
Snippets:1,191
Trust Score:5.1
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Launch Plugarr with interface options

Source: https://github.com/yannickuhrig1/plugarr/blob/main/ASSISTANT-WEB-LOCAL.md

Run the Plugarr assistant with a specific interface. Use --interface web or --interface tui to force the interface, wizard to start the setup wizard, and web --demo for a demonstration mode. The --no-open flag prevents opening the browser, and --port sets the port. Replace python with the virtual environment path if prepared by the Windows launchers.

```powershell
python -m plugarr --interface web
python -m plugarr --interface tui
python -m plugarr wizard --interface web --project-dir "C:\PlugArr-Test"
python -m plugarr web --demo
python -m plugarr web --no-open --port 7375 --project-dir "C:\PlugArr-Test"
```

--------------------------------

### Run plugarr install with --repartir-de-zero

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.md

Reinstalls over an existing installation while ignoring the previous one. By default, install resumes the previous installation's settings, but this option forces a fresh start.

```bash
plugarr install --repartir-de-zero   # ignorer l'installation précédente
```

--------------------------------

### Preview installation without changes

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Runs the installer in dry-run mode to preview what would happen without writing anything.

```bash
plugarr install --dry-run
```

--------------------------------

### Install selected services

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Installs only the specified services (prowlarr, sonarr, radarr, qbittorrent, jellyfin) by passing them as a comma-separated list.

```bash
plugarr install --services prowlarr,sonarr,radarr,qbittorrent,jellyfin
```

--------------------------------

### List templates and install a Recyclarr quality profile

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Use 'plugarr templates' to see the accepted template names, and 'plugarr install --recyclarr-radarr french-multi-vf-hd-bluray-web' to install a specific profile. An unknown name is rejected before anything is written, avoiding a late failure.

```bash
plugarr templates                                            # the accepted names
plugarr install --recyclarr-radarr french-multi-vf-hd-bluray-web
```

--------------------------------

### Set up development environment with git, venv, and editable install

Source: https://github.com/yannickuhrig1/plugarr/blob/main/CONTRIBUTING.en.md

Creates a working copy, a Python virtual environment, and installs the package with development dependencies. Run from your fork's clone URL.

```bash
git clone <your-fork>
cd plugarr
python -m venv .venv
.venv/bin/pip install -e ".[dev]"
```

--------------------------------

### Enable autostart for remote machine: plugarr autostart --systeme --host 0.0.0.0

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Use this command on a server or LXC where no user logs in, to start the console with the machine. It runs under the account that owns stack.yml, not as root. Requires a password to be set when not on 127.0.0.1; otherwise it refuses.

```bash
sudo plugarr autostart --systeme --host 0.0.0.0
```

--------------------------------

### Test PlugArr with Docker: install, test, and serve

Source: https://github.com/yannickuhrig1/plugarr/blob/main/LOCAL_TESTING.md

Install the development environment and run tests, then start the PlugArr server with a custom project directory. Replace the path with the folder containing the stack.yml of your test installation; the source code folder alone is not an installation. The real console opens at the address shown in PowerShell, requires Docker to be accessible, and its actions actually modify the services involved.

```powershell
.\\.venv-local-demo\\Scripts\\python.exe -m pip install -e \".[dev]\"
.\\.venv-local-demo\\Scripts\\python.exe -m pytest -q
.\\.venv-local-demo\\Scripts\\python.exe -m plugarr --help
.\\.venv-local-demo\\Scripts\\python.exe -m plugarr serve --project-dir \"C:\\CHEMIN\\VERS\\PROJET-TEST\"
```

--------------------------------

### Add a missing service

Source: https://github.com/yannickuhrig1/plugarr/blob/main/docs/screenshots/en/10-administration.html

JavaScript for adding a service absent from the installation. The operation is long: it downloads an image, starts the container, and rewires all connections bidirectionally.

```javascript
// Ajout d'un service absent de l'installation. L'operation est longue : elle
// telecharge une image, demarre le conteneur, puis rejoue tout le cablage —
// c'est la seule facon de relier le nouveau venu aux anciens DANS LES DEUX
// SENS.
```

--------------------------------

### Install with --repartir-de-zero to ignore previous installation

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Re-runs install while ignoring the previous installation, discarding any carried-over settings. The flag is given by hand and overrides the default carry-over behavior.

```bash
plugarr install --repartir-de-zero   # ignore the previous installation
```

--------------------------------

### Run PlugArr

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Starts the interactive wizard that deploys and wires the media stack.

```bash
plugarr
```

--------------------------------

### Enable autostart for console: plugarr autostart

Source: https://github.com/yannickuhrig1/plugarr/blob/main/README.en.md

Use this command to make the admin console start with every login session on the host, not in a container. It runs under your account, listens on 127.0.0.1, and stays outside the Docker network. Windows uses a Startup folder script; Linux installs a user systemd unit. Use 'plugarr autostart --disable' to remove it.

```bash
plugarr autostart
```
Tokens:
Raw