Skip to content
LyEve Docs

Server Binary

The engine image carries one binary, lyeve, at /app/lyeve, and runs it as its entrypoint. There is no separate command-line client to install. Everything else is done in the admin console or over the HTTP APIs, which API endpoints lists.

Run the server

Section titled “Run the server”
Terminal window
lyeve

It serves the Admin API on ADMIN_LISTEN_ADDR and the Content API on API_LISTEN_ADDR, which the image sets to 0.0.0.0:3001 and 0.0.0.0:3002. Settings come from environment variables and an optional lyeve.yaml, as Configuration describes.

Every pending database migration runs at start, before the server answers a request. Replicas that start together wait for each other, so only one applies them. There is no separate migration command.

Check health from inside the container

Section titled “Check health from inside the container”
Terminal window
lyeve healthcheck

This requests /healthz on 127.0.0.1 at port PORT (default 3002), over HTTPS when TLS_CERT_FILE is set. It exits 0 on a 200 and 1 otherwise, without starting a server. The image runs it as its container health check. If you move the Content API off port 3002, set PORT to match.

healthcheck is the only argument the binary reads. Any other argument is ignored and the server starts.

Section titled “Related”