Skip to content

Consoles

A console is a shell where your app runs. It goes through the server’s agent, like the web terminal, so it needs no SSH key and no open port 22. Consoles arrived in v0.13.0.

Target Opens
Docker site Its running container
Compose site The running container of the service you pick (asked only when the stack has several)
Native site (PHP, Node, Bun, Deno, static) A shell as the site’s user, in its current release, with the site’s variables
Database instance Its container (falak-db-<id>); the instance must be running
Server A shell as root, or the user you choose
Function No console: functions run on demand

Inside a container the console starts bash when the image has it, else sh. A native site that was never deployed has no current release: the shell starts in the user’s home and says so on its first line.

A site’s ⋯ menu with Console, Network tools and Packet capture.

  • Site: open the site’s panel, then ⋯ → Console. If the site runs on several servers, pick one; for a compose site, pick the service.
  • Database: open the instance page and click Console.

The session page shows the target, for example Console · shop (container web) on main-1.

Consoles use the terminal permissions: terminal.open (owners and admins by default), plus sites.view for a site console or databases.view for a database console. Sharing, watching (terminal.attach), typing into others’ sessions (terminal.control) and recordings work as for the web terminal.

Every console is a terminal session: audited, recorded and listed under Terminal. Unsharing or closing a session, or removing a member, disconnects the clients that lost access.

Consoles and server terminals travel through the relay, a small Go service (about 12 MB) that runs next to the control plane as the compose service relay. Typing costs one network round trip instead of a command long-poll per keystroke.

  • The installer’s compose stack turns it on (FALAK_TERMINAL_RELAY=1). Browsers and the CLI reach it at wss://<panel>/terminal/v1.
  • If the browser can’t reach the relay, the session page falls back to the previous path, so sessions keep working (slower).
  • The CLI only speaks the relay. With the relay off, the console API answers 409 “The terminal relay is off on this installation.”