Skip to content

Commit f740655

Browse files
committed
updated install notes and dependencies in readme
1 parent 904de5e commit f740655

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,19 @@ The CESNET ServicePath Plugin extends NetBox's capabilities by providing compreh
112112
Before installing the plugin, ensure you have:
113113

114114
1. **PostgreSQL with PostGIS extension** (version 3.0 or higher recommended)
115-
2. **System libraries**: GDAL, GEOS, and PROJ
115+
2. **System libraries**: GDAL, GEOS, and PROJ runtime binaries
116116
3. **NetBox 4.2 or higher**
117117

118118
#### Installing System Dependencies
119119

120120
**Ubuntu/Debian:**
121121
```bash
122122
sudo apt-get update
123-
sudo apt-get install postgresql-15-postgis-3 gdal-bin libgdal-dev libgeos-dev libproj-dev
123+
sudo apt-get install postgresql-15-postgis-3 gdal-bin libgdal34 libgeos-c1t64 libproj25
124124
```
125125

126+
**Note**: Package names may vary by Ubuntu/Debian version. Use `apt-cache search libgdal` to find the correct version for your system.
127+
126128
**macOS:**
127129
```bash
128130
brew install postgresql postgis gdal geos proj
@@ -204,9 +206,10 @@ RUN apt-get update && apt-get install -y \
204206
RUN /usr/local/bin/uv pip install \
205207
psycopg2-binary \
206208
-r /opt/netbox/plugin_requirements.txt
207-
208209
```
209210

211+
**Note**: Library package names (like `libgdal34`) may vary depending on the base image's Ubuntu/Debian version. Check available packages if you encounter errors.
212+
210213
Then create a `plugin_requirements.txt` file:
211214
```
212215
cesnet_service_path_plugin
@@ -422,8 +425,8 @@ pip install -e ".[dev]"
422425

423426
4. Install geographic dependencies:
424427
```bash
425-
# Ubuntu/Debian
426-
sudo apt-get install gdal-bin libgdal-dev libgeos-dev libproj-dev
428+
# Ubuntu/Debian - only runtime libraries needed
429+
sudo apt-get install gdal-bin libgdal34 libgeos-c1t64 libproj25
427430
428431
# macOS
429432
brew install gdal geos proj
@@ -432,6 +435,8 @@ brew install gdal geos proj
432435
pip install geopandas fiona shapely
433436
```
434437

438+
**Note**: For development, you typically only need the runtime libraries. The Python packages (geopandas, fiona, shapely) use precompiled wheels that already include the necessary bindings. Development headers (`-dev` packages) are only needed if you're compiling these libraries from source.
439+
435440
### Testing Geographic Features
436441

437442
Use the built-in diagnostic function:
@@ -461,9 +466,10 @@ Automatic integration with existing NetBox models:
461466
### Common Issues
462467

463468
1. **PostGIS not enabled**: Ensure PostGIS extension is installed in your database
464-
2. **GDAL library missing**: Install system GDAL libraries before Python packages
469+
2. **GDAL library missing**: Install system GDAL runtime libraries (`gdal-bin`, `libgdal34`) before Python packages
465470
3. **Path upload fails**: Check file format and ensure it contains LineString geometries
466471
4. **Map not loading**: Verify JavaScript console for tile layer errors
472+
5. **Library version mismatch**: If you encounter errors about missing libraries, check that library package names match your OS version (e.g., `libgdal34` vs `libgdal32`)
467473

468474
### Debug Mode
469475

0 commit comments

Comments
 (0)