Skip to main content
Someone sent you a link to their app, and you want to run your own copy of it on your own server. For example, an agency built a booking app for you and wants it to run on a server your company pays for, with your data staying there. This guide takes you from the link to the running app.

What happens to your server

You run one command on your server. It installs the Kubernetes worker software (k0s) and connects your server to Akua, which then starts the app on it. The app and its data run on your server, and you pay your server provider directly. The person who sent you the link can’t sign in to your account or change your copy of the app. What runs on your server lists everything the command installs.

Prerequisites

  • The link you received.
  • An email address to sign in to Akua. Signing in creates your Akua account if you don’t have one.
  • A Linux server that meets the server requirements: at least 2 CPUs and 4 GB of memory, root access over SSH, and outbound internet access. Akua tests Ubuntu 24.04 on x86-64. Use a fresh server that runs nothing else. No server? Use an Akua trial server instead.

Install the app

The app’s page shows two ways to run it: Your own server, which this guide follows, or An Akua server, a free trial server that Akua prepares for you (see Use an Akua trial server instead).
1

Open the link and sign in

Open the link and click Sign in to continue (or Sign in, if the page says Sign in to see your invitation). Enter your email address, click Continue with Email and follow the link in the email you receive. If the link was sent to your email address, sign in with that one. You come back to the app’s page, which now has two parts, Server and Settings, and an Install app button.
2

Choose your Workspace

Under Server, choose the Workspace that should own the app. A Workspace is your own space in Akua; the app, its server and its settings belong to it. If you have no Workspace yet, enter a Workspace name. If you have no Organization yet either, also enter an Organization name, such as your company’s name. Click Create Workspace.
3

Add your server

Under Your own server, click Add a server. Review your server shows the group your server joins: Akua creates it for you, named after your Workspace, in its default region. Click Change if you want another name or region. Click Create join command.
4

Copy the join command

Connect your server shows the command in a Shell block. Click Copy command. The command is for one server: it stops working 15 minutes after its first use, or after one hour if it is not used. It is shown only on this page.Keep the command private: anyone who runs it can add a server to your Workspace.
5

Run the command on your server

Connect to your server over SSH and run the command exactly as shown. It starts with curl -fsSL and downloads join.sh from Akua, then runs it with sudo sh join.sh, so it runs as root. It first checks the command’s token, then installs the worker software and joins your server. It prints Akua join: messages and ends with Worker joined and started; wait for Ready in the dashboard.
6

Wait for your server to be ready

In Akua, click Done to return to the app’s page. The page updates by itself: Server shows your server as Ready a minute or two after it joined.
7

Check the settings

Open Settings. Some values may already be filled in or locked by the person who sent you the link. If the app asks for values, fill them in and click Save and continue. If it shows Nothing to set, there is nothing to do.
8

Install and open the app

Click Install app once. When the app is running, click Open app; View install opens it in your dashboard. If you reload the page or open the link again, Akua shows the same install instead of starting a second one.
Confirmation that the shared app is running, with View install and Open app controls.

When the app is running, Open app takes you to it.

The app’s address ends in akua.run and uses HTTPS. You can share it with your team; you don’t need to set up DNS or certificates.

Use an Akua trial server instead

If you don’t have a server, click Start a trial server under An Akua server. Akua prepares a small server for you on Hetzner. One trial server is available per person. In the short Add server setup, click Add card if Akua asks for one and verify a card; the card is not charged. Click Start free trial server, then Done to return to the app’s page, which shows the server as Ready once it is prepared. Then continue with the settings and Install app. The trial server pauses days after it starts running, and the app on it stops. Akua keeps a snapshot of its disk for days after the pause, then deletes it with the app’s data. See Akua servers.

If the server doesn’t join

The command prints Akua join: messages. If it stops with an error, fix the cause it names, then create a new join command and run it again. Common causes:
  • The Cluster refused the token in this join command. The command is wrong, expired or was revoked, or could not be checked right now. Run it once more; if it is refused again, create a new one. The command stops before it installs anything.
  • Run this command as root. Run it exactly as shown, including sudo.
  • This server belongs to another Cluster or An existing k0s installation is not managed by this command. Start again with a fresh server.
  • Worker bootstrap timed out. The command shows the last lines of the worker’s log and stops the worker. Check the server’s outbound connection, then create a new command and run it.
For anything else, see Get help.

Next steps

Update or remove the app

New versions of the app, and how to remove it.

What runs on your server

What the command installs and what it connects to.

Get help

Where to ask when something doesn’t work.