Skip to content
ElyraElyraElyra

Install on a Linux server

For a headless Linux machine: one command installs Elyra as a service and leaves the server ready to activate.

View Markdown

This path is for a headless Linux machine, such as a cloud server reached over SSH. On a computer with a screen, running Windows, macOS or Linux, the simplest way is to turn on the Cloud from the app.

Installation is a single command, run in the server’s terminal.

Before you start

  • A Linux machine with systemd: Ubuntu 20.04 or newer, or Debian 11 or newer, on x64 or arm64.
  • Terminal access to it, as root or as a regular user with sudo.
  • Outbound internet. You do not need to open a port or configure DNS.
  • The account requirements are in the overview.
  • Run it as the user who will keep the service. The installer creates a service for that user, not for the whole system.
  • Without root and without sudo, the installer stops before downloading anything and says so.

Run the installer

curl -fsSL https://app.elyra.sh/cloud/instalar.sh | sh

Each step appears on a line with its status. At the end, the installer waits for the server to come up and shows the activation code: continue in Activate the server.

Choose how to activate

In an interactive terminal, activation starts with the question “How do you want to sign in?”. Choose with the arrow keys (or type 1 or 2) and confirm with Enter:

  • Sign in with a link: opens the browser when there is a graphical environment; otherwise, shows the address for you to open.
  • Use a QR Code: shows the QR in the terminal, for you to point your phone’s camera at.

To skip the question, use the direct form:

curl -fsSL https://app.elyra.sh/cloud/instalar.sh | sh -s -- --link
curl -fsSL https://app.elyra.sh/cloud/instalar.sh | sh -s -- --qr

With no terminal to ask in, activation proceeds through the link. --help shows a summary of the options, and any other argument is refused.

Language

The installer speaks Portuguese, English and Spanish. It follows the system language (LC_ALL, LC_MESSAGES or LANG, in that order): Portuguese and Spanish are recognized, and any other, including C and POSIX, falls back to English. To choose, use --lang:

curl -fsSL https://app.elyra.sh/cloud/instalar.sh | sh -s -- --lang pt-br
curl -fsSL https://app.elyra.sh/cloud/instalar.sh | sh -s -- --lang en --link

--lang accepts pt-br, en and es, and also forms such as pt, pt_BR, en-US and es-419. It takes precedence over the system language and combines with --link, --qr and --help.

What the installer does

  1. Checks the distribution and architecture, and refuses the ones it does not support.
  2. Downloads the Elyra package for Linux and checks its checksum (SHA-256) before installing. It prefers the .deb package; when that is not available, it uses a fallback AppImage, kept in your user’s data folder.
  3. Installs the libraries Elyra needs that are still missing, plus xvfb (virtual display). They stay on the system afterward, because other programs may use them.
  4. Creates and enables the user service elyra-cloud.service, which comes back on its own after the machine reboots.
  5. Turns on the user’s linger, if it was off, so the service runs even with no open session. If it was already on, it does not touch it.
  6. Writes a minimal passwordless sudo rule at /etc/sudoers.d/elyra-cloud-<user>. It lets your user run, as root and without a password, only four commands: turn linger on, turn linger off, dpkg -r elyra and delete this file itself. Those are what the uninstaller needs; the uninstaller removes the rule last.
  7. Writes an inventory of what it installed in the Cloud profile, so the uninstall undoes only what belongs to Elyra.
  8. Starts the service and follows its startup to show the activation code.

Running it again is safe

The installer is idempotent: running it twice gives the same result as running it once.

  • Identical service, sudo rule and files are not rewritten.
  • With the package already installed, it updates when a newer version exists and never goes back to an older one.
  • What already existed on the machine before (a package, linger) is never taken as its own nor removed afterward.
  • A file the installer does not recognize as its own is not overwritten: it stops, warns you and changes nothing.

If something fails midway, the installer undoes what it did in that run and shows the last lines of what ran and where the full record is.

Next steps