MrBlake/NetBox-Concept
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document pip install/update via git repo in README

Browse Source 
Adds instructions for installing and upgrading the plugin directly via
pip from git.mrblake.cc, including pinning a ref, wiring it into
local_requirements.txt for upgrade.sh, and the force-reinstall caveat
needed to pick up updates from an unversioned git URL.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
MrBlake
2026-09-16 09:02:15 +02:00
co-authored by Claude Sonnet 5
parent 17cf94ac0d
commit 7b9b85776b
1 changed files with 41 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+41
View File
@@ -48,11 +48,36 @@ funktioniert weiter, und es landet eine Warnung im NetBox-Log.
## Installation ## Installation
### Per pip direkt aus Git
```bash
source /opt/netbox/venv/bin/activate
pip install git+https://git.mrblake.cc/MrBlake/NetBox-Concept.git
```
Für eine bestimmte Version oder einen Branch/Commit `@<ref>` anhängen, z.B.:
```bash
pip install git+https://git.mrblake.cc/MrBlake/NetBox-Concept.git@v0.1.0
```
Damit die Installation auch nach einem `upgrade.sh`/`python3 -m pip install -r
requirements.txt`-Lauf erhalten bleibt, den Eintrag zusätzlich in
`/opt/netbox/local_requirements.txt` aufnehmen:
```
git+https://git.mrblake.cc/MrBlake/NetBox-Concept.git
```
### Aus lokalem Checkout
```bash ```bash
source /opt/netbox/venv/bin/activate source /opt/netbox/venv/bin/activate
pip install /pfad/zu/netbox-rack-concept pip install /pfad/zu/netbox-rack-concept
``` ```
### Aktivieren
In `configuration.py`: In `configuration.py`:
```python ```python
@@ -73,6 +98,22 @@ python manage.py collectstatic --no-input
sudo systemctl restart netbox netbox-rq sudo systemctl restart netbox netbox-rq
``` ```
## Update
```bash
source /opt/netbox/venv/bin/activate
pip install --upgrade --force-reinstall --no-deps git+https://git.mrblake.cc/MrBlake/NetBox-Concept.git
cd /opt/netbox/netbox
python manage.py migrate
python manage.py collectstatic --no-input
sudo systemctl restart netbox netbox-rq
```
`--force-reinstall --no-deps` ist nötig, weil pip bei einer git-URL ohne Versionsänderung
sonst annimmt, es sei nichts Neues zu holen. Wer stattdessen mit `local_requirements.txt`
und `upgrade.sh` arbeitet, bekommt Updates darüber automatisch mit, sobald sich der
referenzierte Branch/Tag ändert.
> Sollte `migrate` die mitgelieferte Migration nicht anwenden können, weil sich in eurer > Sollte `migrate` die mitgelieferte Migration nicht anwenden können, weil sich in eurer
> NetBox-Installation Basisfelder unterscheiden: `netbox_rack_concept/migrations/0001_initial.py` > NetBox-Installation Basisfelder unterscheiden: `netbox_rack_concept/migrations/0001_initial.py`
> löschen und `python manage.py makemigrations netbox_rack_concept` laufen lassen. > löschen und `python manage.py makemigrations netbox_rack_concept` laufen lassen.