ccsfr/haptique-os-server repository overview

⁠Haptique OS Server

Haptique OS Server is the Docker image for self-hosted local deployments and LAN testing. It runs the Haptique OS web app, local OS API, driver runtime, device state, automations, and persistent local storage in one container.

⁠Quick start

Run the latest published image:

docker run -d \
  --name haptique-os \
  -p 8080:8080 \
  -v haptique-os-data:/app/storage \
  ccsfr/haptique-os-server:latest

Open the app:

http://localhost:8080/os

On first run, complete the license step in the browser, then create the first admin account.

⁠Notes

• Mount a volume at /app/storage to keep the SQLite database, local assets, integration packages, licenses, generated secrets, and admin account outside the container layer.
• Without a mounted volume, replacing the container resets the local database, generated secrets, and first-run admin account.
• latest tracks the latest pushed image. Prefer a version tag or sha-<commit> tag for repeatable installs.
• Optional provider credentials, OAuth settings, remote access settings, and integration-specific environment variables can be added as needed.
• LAN or reverse-proxy URL configuration can be added later when a feature needs it.

To inspect logs:

docker logs -f haptique-os

To stop the container:

docker stop haptique-os

To remove the container but keep data:

docker rm haptique-os

⁠Security notes

• Complete licensing and create the first admin account before sharing the instance on a LAN.
• Use HTTPS or a trusted reverse proxy when exposing Haptique OS outside localhost.
• Do not expose the container directly to the public internet without access controls.
• Keep persistent storage backed up before replacing tags or resetting volumes.

⁠Health check

After startup, verify the server:

http://localhost:8080/healthcheck

The OS API is available under:

http://localhost:8080/app/os

API docs are available under:

http://localhost:8080/app/os/docs