2025-12-11 18:32:55 -07:00
|
|
|
"""
|
|
|
|
|
Docker container management for WROLPi Controller.
|
|
|
|
|
|
|
|
|
|
Used when running in Docker mode instead of systemd.
|
|
|
|
|
"""
|
|
|
|
|
|
2026-03-14 10:03:11 -06:00
|
|
|
import logging
|
2025-12-11 18:32:55 -07:00
|
|
|
import os
|
|
|
|
|
|
|
|
|
|
from controller.lib.config import is_docker_mode
|
|
|
|
|
|
2026-03-14 10:03:11 -06:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
2025-12-11 18:32:55 -07:00
|
|
|
# Import docker only if available (optional dependency)
|
|
|
|
|
try:
|
|
|
|
|
import docker
|
|
|
|
|
from docker.errors import NotFound, APIError
|
|
|
|
|
|
|
|
|
|
DOCKER_AVAILABLE = True
|
|
|
|
|
except ImportError:
|
|
|
|
|
DOCKER_AVAILABLE = False
|
|
|
|
|
docker = None
|
|
|
|
|
NotFound = Exception
|
|
|
|
|
APIError = Exception
|
|
|
|
|
|
|
|
|
|
# Container name prefix (from docker-compose project)
|
|
|
|
|
CONTAINER_PREFIX = os.environ.get("COMPOSE_PROJECT_NAME", "wrolpi")
|
|
|
|
|
|
|
|
|
|
# Containers that should not have a "View" button (non-HTTP services)
|
A WROLPi serves its library over rsync, and makes a database snapshot on request (#988)
* A WROLPi serves its library over rsync, and makes a database snapshot on request
The first part of replacing the sync: a secondary will copy its primary's whole media directory with rsync and
replace its database with the primary's, instead of downloading the files of FileGroups over HTTP (which never
copies an ignored directory, such as the map's).
- An rsync daemon serves the media directory read-only on port 8873, on every WROLPi. It never serves the TLS keys,
the cookies, or the database in use. On a Raspberry Pi and Debian it is the wrolpi-rsyncd unit; in Docker the
Controller runs it in a helper container made from the api container (its image, user and volumes), so the media
directory is still configured in one place. All three read controller/rsyncd.conf.
- POST /api/sync/snapshot asks for a snapshot of the database, which the daemon serves from config/.sync. An
unchanged database is not written again.
- /api/sync/info also says the database's migration and whether the media directory is mounted.
Nothing uses these yet; the existing sync is unchanged.
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
* The rsync daemon follows no links, and no snapshot is made in WROL Mode
- A client that asked the daemon to follow symbolic links could read what a link in the library points at. A
relative link to config/ssl was read this way although that directory is left out of the module. The daemon now
refuses the three options that follow links; a link is sent as a link.
- A database snapshot is a new file on the primary's drive, so WROL Mode refuses it, as it does a backup. A snapshot
made earlier is still served.
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
* No rsync helper from an image without rsync, and the helper follows the api container
Review found:
- A helper made from an api image built before rsync was added exits at once, and Docker restarted it forever while
the Controller reported it created. The image is now looked at first; no helper is made from one without rsync,
an older helper is left serving, and the reason is logged once.
- The helper was only checked when the Controller started, so a recreated or rebuilt api container left it stale.
It is now checked every minute.
- A snapshot cut off by its process being killed stayed marked as running and held back every later request.
- The snapshot's half-written temporary file was served by the daemon.
- The comment on the daemon's refused options claimed more than they give: a link that is part of the requested
path is still followed.
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-18 16:47:02 -07:00
|
|
|
NON_VIEWABLE_CONTAINERS = {"redis", "memcached", "samba", "rsyncd"}
|
2025-12-11 18:32:55 -07:00
|
|
|
|
Replace nginx with Caddy for TLS termination and reverse proxying.
- Replace nginx with Caddy as the web server for both Docker and native
(RPi/Debian) deployments. Caddy handles HTTPS termination, reverse
proxying to all services (API, React app, Controller, Kiwix, Help, Map),
and serves the media/download file browsers.
- Generate a Root CA and signed leaf certificates for HTTPS. The Root CA
uses Name Constraints to restrict signing to local addresses only
(.local, localhost, and RFC 1918 private IP ranges), mitigating MITM
risk if the CA key is compromised.
- Add an HTTP landing page that guides users through one-time CA
certificate installation on iOS, Android, macOS, Windows, Linux, and
Firefox, with auto-redirect when the cert is already trusted.
- Add trailing-slash redirects for /controller, /docs, /media, and
/download so bare paths don't fall through to the React catch-all.
- Add a Root CA download link on the Settings page under Configs.
- Update help.sh diagnostics for IPv6 listener detection and HTTP/2
status codes.
- Remove all nginx config files and the https_proxy Docker container.
- Bump wrolpi-help submodule with certificate documentation.
2026-03-07 12:08:27 -07:00
|
|
|
# Containers that should use HTTPS
|
2025-12-11 18:32:55 -07:00
|
|
|
HTTPS_CONTAINERS = {"web"}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def can_manage_containers() -> bool:
|
|
|
|
|
"""Check if we can manage Docker containers."""
|
|
|
|
|
if not is_docker_mode():
|
|
|
|
|
return False
|
|
|
|
|
if not DOCKER_AVAILABLE:
|
|
|
|
|
return False
|
|
|
|
|
if not os.path.exists("/var/run/docker.sock"):
|
|
|
|
|
return False
|
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _get_client():
|
|
|
|
|
"""Get Docker client."""
|
|
|
|
|
if not DOCKER_AVAILABLE:
|
|
|
|
|
raise RuntimeError("Docker library not installed")
|
|
|
|
|
return docker.from_env()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _get_container_name(service_name: str) -> str:
|
|
|
|
|
"""Convert service name to container name."""
|
|
|
|
|
# docker-compose names: {project}-{service}-{number}
|
|
|
|
|
return f"{CONTAINER_PREFIX}-{service_name}-1"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_container_status(name: str) -> dict:
|
|
|
|
|
"""
|
|
|
|
|
Get status of a Docker container.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
name: Service name
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
dict with status info
|
|
|
|
|
"""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return {
|
|
|
|
|
"name": name,
|
|
|
|
|
"status": "unknown",
|
|
|
|
|
"available": False,
|
|
|
|
|
"reason": "Docker management not available",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
container_name = _get_container_name(name)
|
|
|
|
|
container = client.containers.get(container_name)
|
|
|
|
|
|
|
|
|
|
# Map Docker status to our status
|
|
|
|
|
docker_status = container.status
|
|
|
|
|
if docker_status == "running":
|
|
|
|
|
status = "running"
|
|
|
|
|
elif docker_status == "exited":
|
|
|
|
|
status = "stopped"
|
|
|
|
|
elif docker_status == "restarting":
|
|
|
|
|
status = "restarting"
|
|
|
|
|
else:
|
|
|
|
|
status = docker_status
|
|
|
|
|
|
|
|
|
|
# Get port info from container
|
|
|
|
|
ports = container.attrs.get("NetworkSettings", {}).get("Ports", {})
|
|
|
|
|
port = None
|
|
|
|
|
for container_port, host_bindings in ports.items():
|
|
|
|
|
if host_bindings:
|
|
|
|
|
port = int(host_bindings[0].get("HostPort", 0))
|
|
|
|
|
break
|
|
|
|
|
|
|
|
|
|
return {
|
|
|
|
|
"name": name,
|
|
|
|
|
"container_name": container_name,
|
|
|
|
|
"status": status,
|
|
|
|
|
"docker_status": docker_status,
|
|
|
|
|
"port": port,
|
|
|
|
|
"available": True,
|
|
|
|
|
"viewable": name not in NON_VIEWABLE_CONTAINERS,
|
|
|
|
|
"use_https": name.endswith("_https") or name in HTTPS_CONTAINERS,
|
|
|
|
|
}
|
|
|
|
|
except NotFound:
|
|
|
|
|
return {
|
|
|
|
|
"name": name,
|
|
|
|
|
"status": "not_found",
|
|
|
|
|
"available": True,
|
|
|
|
|
}
|
|
|
|
|
except Exception as e:
|
|
|
|
|
return {
|
|
|
|
|
"name": name,
|
|
|
|
|
"status": "error",
|
|
|
|
|
"error": str(e),
|
|
|
|
|
"available": False,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_all_containers_status() -> list[dict]:
|
|
|
|
|
"""
|
|
|
|
|
Get status of all WROLPi containers.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
list of container status dicts
|
|
|
|
|
"""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
containers = client.containers.list(all=True)
|
|
|
|
|
|
|
|
|
|
results = []
|
|
|
|
|
for container in containers:
|
|
|
|
|
if container.name.startswith(CONTAINER_PREFIX):
|
|
|
|
|
# Extract service name from container name
|
|
|
|
|
parts = container.name.split("-")
|
|
|
|
|
if len(parts) >= 2:
|
|
|
|
|
service_name = parts[1]
|
|
|
|
|
else:
|
|
|
|
|
service_name = container.name
|
|
|
|
|
|
|
|
|
|
# Get port info from container
|
|
|
|
|
ports = container.attrs.get("NetworkSettings", {}).get("Ports", {})
|
|
|
|
|
port = None
|
|
|
|
|
for container_port, host_bindings in ports.items():
|
|
|
|
|
if host_bindings:
|
|
|
|
|
port = int(host_bindings[0].get("HostPort", 0))
|
|
|
|
|
break
|
|
|
|
|
|
|
|
|
|
results.append({
|
|
|
|
|
"name": service_name,
|
|
|
|
|
"container_name": container.name,
|
|
|
|
|
"status": "running" if container.status == "running" else "stopped",
|
|
|
|
|
"docker_status": container.status,
|
|
|
|
|
"port": port,
|
|
|
|
|
"viewable": service_name not in NON_VIEWABLE_CONTAINERS,
|
|
|
|
|
"use_https": service_name.endswith("_https") or service_name in HTTPS_CONTAINERS,
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
return results
|
|
|
|
|
except Exception as e:
|
|
|
|
|
return [{"error": str(e)}]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def start_container(name: str) -> dict:
|
|
|
|
|
"""Start a Docker container."""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return {"success": False, "error": "Docker management not available"}
|
|
|
|
|
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Starting container %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
container_name = _get_container_name(name)
|
|
|
|
|
container = client.containers.get(container_name)
|
|
|
|
|
container.start()
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Container %s started successfully", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": True, "service": name, "action": "start"}
|
|
|
|
|
except NotFound:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Container not found: %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": f"Container not found: {name}"}
|
|
|
|
|
except Exception as e:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Failed to start container %s: %s", name, e)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": str(e)}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def stop_container(name: str) -> dict:
|
|
|
|
|
"""Stop a Docker container."""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return {"success": False, "error": "Docker management not available"}
|
|
|
|
|
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Stopping container %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
container_name = _get_container_name(name)
|
|
|
|
|
container = client.containers.get(container_name)
|
|
|
|
|
container.stop(timeout=30)
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Container %s stopped successfully", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": True, "service": name, "action": "stop"}
|
|
|
|
|
except NotFound:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Container not found: %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": f"Container not found: {name}"}
|
|
|
|
|
except Exception as e:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Failed to stop container %s: %s", name, e)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": str(e)}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def restart_container(name: str) -> dict:
|
|
|
|
|
"""Restart a Docker container."""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return {"success": False, "error": "Docker management not available"}
|
|
|
|
|
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Restarting container %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
container_name = _get_container_name(name)
|
|
|
|
|
container = client.containers.get(container_name)
|
|
|
|
|
container.restart(timeout=30)
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.info("Container %s restarted successfully", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": True, "service": name, "action": "restart"}
|
|
|
|
|
except NotFound:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Container not found: %s", name)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": f"Container not found: {name}"}
|
|
|
|
|
except Exception as e:
|
2026-03-14 10:03:11 -06:00
|
|
|
logger.warning("Failed to restart container %s: %s", name, e)
|
2025-12-11 18:32:55 -07:00
|
|
|
return {"success": False, "error": str(e)}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_container_logs(name: str, lines: int = 100) -> dict:
|
|
|
|
|
"""Get logs from a Docker container."""
|
|
|
|
|
if not can_manage_containers():
|
|
|
|
|
return {"error": "Docker management not available"}
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
client = _get_client()
|
|
|
|
|
container_name = _get_container_name(name)
|
|
|
|
|
container = client.containers.get(container_name)
|
|
|
|
|
logs = container.logs(tail=lines).decode("utf-8")
|
|
|
|
|
return {
|
|
|
|
|
"service": name,
|
|
|
|
|
"lines": lines,
|
|
|
|
|
"logs": logs,
|
|
|
|
|
}
|
|
|
|
|
except NotFound:
|
|
|
|
|
return {"error": f"Container not found: {name}"}
|
|
|
|
|
except Exception as e:
|
|
|
|
|
return {"error": str(e)}
|