Getting started

Installation

Every product installs with one command and your licence key. The installer checks the key, downloads the release your licence covers, and runs that product's own setup.

Before you start

Server
A fresh Ubuntu or Debian server, or VPS, that you control
Access
Root, or a user who can run sudo
Licence key
In your account, on the Downloads tab (AK-XXXX-XXXX-XXXX)
Product needs
Anything a product needs on top is set up by its own installer; the product page lists it

The install command

Sign in, open your account, and copy the command shown under the product on the Downloads tab: it already has your product and your licence key in it. Run it on the server:

install
curl -fsSL https://store.appkodes.com/install/<product>.sh | sudo bash -s -- --licence=AK-XXXX-XXXX-XXXX

Run without --licence, it asks for the key on the terminal instead.

Copy the command from your account rather than retyping this one. The key is checked against your licence on every install, and a mistyped key is refused.

Installing on a new server's first boot

You do not need to log in to the server at all. Most cloud providers let you paste a script that runs when a new server first starts (on DigitalOcean it is the User data field when you create a droplet). Paste the command from your account there, with the licence key in it, and the server installs the product on its own.

What the installer does

  1. 1Installs curl and unzip if the server does not have them.
  2. 2Sends your licence key to the store, which checks it and returns the release your licence covers.
  3. 3Unpacks that release into /opt/<product> on the server.
  4. 4Runs the product's own setup script from the release, which installs what that product needs and starts it.
  5. 5Finishes by printing the product name, the version installed and where it is.

Options

Some products take extra options after the licence key, such as the domain to serve on or the admin's email address. The first lines of each product's installer list the options it accepts:

options
curl -fsSL https://store.appkodes.com/install/<product>.sh | head -5

Updating

Run the same command again. The installer downloads the release your licence covers and unpacks it over the existing install: your configuration, uploads and database are not part of the release, so the code is updated and your data stays. Updates within the version line you bought are free.

Stuck on an install? Installation help is included with every licence, on both support plans.