lrnselfreliance/wrolpi repository overview

⁠WROLPi

A self-hosted app suite for TrueNAS SCALE, Unraid, Proxmox, or any Docker-compatible platform.

⁠Overview

WROLPi provides a suite of services including a web interface, API, React app, map tile server, ZIM content server, and help documentation, all deployed via Docker Compose.

⁠Prerequisites

• Docker and Docker Compose installed
• Storage for persistent data (e.g., TrueNAS: /mnt/tank, Unraid: /mnt/user, Proxmox: /var/lib/docker/volumes)
• Access to lrnselfreliance/wrolpi images on Docker Hub

⁠Setup

1. Mount the directory you want WROLPi to download files onto media_data.
2. Access Services:
   • Web: http://<host>:8080 or https://<host>:8443
   • App: http://<host>:3000
   • API: http://<host>:8081/api/echo
   • Map: https://<host>:8084
   • ZIM: https://<host>:8085
   • Help: https://<host>:8086

⁠Environment Variables

• UID/GID: User/Group ID for API and app (default: 1000)
• DB_PORT: PostgreSQL port (default: 5432)
• API_PORT: API port (default: 8081)
• APP_PORT: React app port (default: 3000)
• ARCHIVE_PORT: Archive port (default: 8083)
• MAP_HTTPS_PORT: Map HTTPS port (default: 8084)
• WEB_PORT/WEB_HTTPS_PORT: Web ports (default: 8080, 8443)
• ZIM_HTTPS_PORT: ZIM HTTPS port (default: 8085)
• HELP_HTTPS_PORT: Help HTTPS port (default: 8086)

⁠Volumes

• pg_data: PostgreSQL data (e.g., /mnt/tank/wrolpi/pg_data)
• media_data: The place where WROLPi will download your files (e.g., /mnt/tank/wrolpi/media)
• openstreetmap_data: Map database (e.g., /mnt/tank/wrolpi/openstreetmap_data)
• openstreetmap_rendered_tiles: Map tiles (e.g., /mnt/tank/wrolpi/openstreetmap_rendered_tiles)

⁠Notes

• Images are hosted on Docker Hub (lrnselfreliance/wrolpi).
• For HTTPS services, Nginx configs are baked into images.
• Customize volume paths and ports via environment variables.
• For issues, check GitHub⁠ or Docker Hub.