RoqueOS Server Installation

Transform RoqueOS into a powerful self-hosted cloud computing platform. Install with Docker to unlock a Linux terminal, remote browser, Docker App Store, file manager, and much more.

---

Prerequisites

PREREQUISITES

You will need a machine running Linux (Ubuntu/Debian recommended) or macOS/Windows with Docker and Docker Compose installed.

Don't have Docker? Install Docker Engine before continuing.

---

Option 1: Automatic Installation (Recommended)

The easiest and fastest way. The script will download and configure everything for you.

Linux / macOS

curl -fsSL https://roqueos.com.br/install.sh | bash

Windows

iwr -useb https://roqueos.com.br/install.ps1 | iex

After execution, the server will be running and ready to receive connections from the frontend.

---

Option 2: Manual Installation

For those who prefer to manage containers on their own.

1. Download images from DockerHub

docker pull roqueribeiro1988/roqueos-server:latest
docker pull roqueribeiro1988/roqueos-server-ubuntu:latest

2. Create the docker-compose.yml file

version: '3.8'

services:
  roqueos-server:
    image: roqueribeiro1988/roqueos-server:latest
    container_name: roqueos-server
    restart: unless-stopped
    ports:
      - '27021:27021'
    volumes:
      - ./data:/app/data
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - TZ=America/Sao_Paulo

3. Start the server

docker compose up -d

---

Verifying the Installation

curl http://localhost:27021/health

Expected result:

{ "status": "ok", "timestamp": "2026-03-05T00:00:00.000Z", "version": "2.1.0" }

---

Administration Panel

After installation, the Administration Panel is available at:

http://localhost:27021/api

In the panel, you can:

• Create and manage API Keys to connect the frontend
• Monitor running containers and services
• Configure Cloudflare tunnels for secure external access

---

Connecting to the Frontend

1. Open RoqueOS at roqueos.com.br or in the native app.
2. Go to Settings → Server.
3. Enter the server URL (e.g., http://localhost:27021 or https://your-tunnel.trycloudflare.com).
4. Paste the API Key generated in the administration panel.
5. Click Connect.

---

Next Steps

• VPS & Cloud — Install on a remote server for 24/7 access
• Volumes (Disks) — Map your local folders in the file manager
• Docker App Store — Install Docker applications with one click