Before you start
For a deployment that runs tasks on the same host, prepare:
The installer sets up Docker and Compose when needed, the Roomote services,
databases, generated secrets, HTTPS through Caddy, and the
roomote host CLI.
Choose a dedicated host with ports 80 and 443 available.
1. Choose the matching installation path
If you are asking a coding agent to install Roomote, give it the
agent installation guide.
2. Prepare the server’s URL
Choose a domain such asroomote.example.com. In your DNS provider, create
these records, replacing the example address with your server’s public IPv4
address:
Try a public server without buying a domain
Try a public server without buying a domain
If the server has a directly reachable public IPv4 address and ports 80
and 443 are open, you can omit
--domain from the install command below.
The installer uses an automatic sslip.io hostname with HTTPS. This is a
short evaluation option: the hostname depends on your IP address and shares
certificate rate limits with other sslip.io users.A computer behind a home router still needs port forwarding or a tunnel.
Follow Connect your home network
to prepare a stable URL for that case.3. Install Roomote
Open a terminal on the Linux host, or SSH into it. Install the small tools used by the installer:q to leave less. Replace roomote.example.com with the domain you
prepared. The installer downloads the published Roomote images and starts
the services. When it finishes, it prints a setup link for the first
administrator. Keep this link private.
Run:
sudo roomote setup-url in your terminal.
If the page does not load, check the DNS records and ports from step 2, then
inspect sudo roomote logs. More troubleshooting is in
Operate a self-hosted deployment.