Linux server
Install octoboardd, the Octoboard server program (the app calls it the daemon), on a Linux server without root. Reach it from the macOS or Windows app, or from a browser, both through SSH.
For x86_64 and aarch64, on any distribution.
Before you start
Section titled “Before you start”- A Linux server you can sign in to with SSH. SSH is a secure way to sign in to another machine and type commands on it. The server’s provider gives you its address and your user name.
- The Octoboard app on your own computer, for macOS or Windows, if you want to work in the desktop app (recommended).
To sign in, open Terminal (macOS) or PowerShell (Windows) on your own computer and run the command below, with your user name in place of <you> and the server’s address in place of <server>. The first time, answer yes when it asks whether to trust the server.
ssh <you>@<server>Steps 1 and 2 below run on the server, in that signed-in window.
Install
Section titled “Install”-
Install octoboardd on the server.
Terminal window curl --proto '=https' --tlsv1.2 -fsSL https://octoboard.dev/install.sh | shIt prints a line beginning
Installed octoboardd. -
Start it on the server.
Terminal window octoboardd startIt prints a line beginning
Octoboard started. -
Connect to it from your own computer, in one of two ways:
-
From the desktop app (recommended): follow Connect to a Linux server in the SSH guide.
-
From a browser: run this on the server.
Terminal window octoboardd addressIt prints two things: a browser address, starting with
http://127.0.0.1:, and ansshcommand. On your own computer, copy thesshcommand, replace<server>with the server’s address (the IP address or name you use to sign in to it), and run it in Terminal or PowerShell. It may ask for your password, then shows nothing more; that’s normal. Leave that window open: closing it cuts the connection. Then open the printed address in your browser.
-
You’ll know it worked when Octoboard opens in the desktop app’s new window, or in the browser tab.
If octoboardd isn’t found
Section titled “If octoboardd isn’t found”If the install says a folder ending in .local/bin (such as /home/<you>/.local/bin) is not on your PATH, the shell can’t find octoboardd by name. Run it by the full path the install printed, or add ~/.local/bin to your PATH (for example in ~/.profile) and sign in again.
Keep it running after you log out or reboot
Section titled “Keep it running after you log out or reboot”Started with octoboardd start, octoboardd stops when the server restarts, and nothing starts it again by itself: run octoboardd start again, or connect from the desktop app, which offers to start it for you. Some servers also stop it when you sign out.
To have it start whenever the server starts and keep running after you sign out, install it as a service instead:
curl --proto '=https' --tlsv1.2 -fsSL https://octoboard.dev/install.sh | sh -s -- --serviceThis installs the program, sets it up as a systemd user service and starts it. It then turns on lingering, which lets your services run while you aren’t signed in. If it says it could not, run this once (it may need sudo):
loginctl enable-linger "$USER"The default port is 3369. To use another, add --port <port> to the end of the service command, or to octoboardd start.
Upgrade
Section titled “Upgrade”Octoboard never upgrades itself on its own: when a new version is out, the browser tells you, and you choose when to install it. Once the new version is installed, Octoboard restarts into it by itself when no session would be interrupted; if some would be, it lists them and asks first.
-
In the browser: select Download and install where it says a new version is available.
-
On the server: run this command.
Terminal window octoboardd updateIf it asks whether to restart now, answer
yto restart, or press Enter to keep the old version running for now. To restart later, runoctoboardd restart.
If octoboardd update says it can’t replace the program, for example because it was installed somewhere you can’t write to, run the install command (or the service command) again instead. It restarts in the same way when that’s safe, and otherwise tells you to run octoboardd restart.