Managing Sites and Apps

/docs/gears/managing/

Here is a summary of common tasks when managing the Sites and Apps on your Device.

Note

To find out about more options any command, add --help as an argument to the command.

Obtaining information about your Device

Displaying the overall status of your Device

To show a summary of relevant information about your Device, execute:

% sudo ubos-admin status

Displaying the currently installed Sites and Apps

To list the currently installed Sites and Apps, execute:

% sudo ubos-admin listsites

Displaying Site information

To show information about a currently installed Site with hostname hostname, execute:

% sudo ubos-admin showsite --hostname <hostname>

Deploying or redeploying a Site with App(s) and Accessory/ies

Determining the list of available Apps and Accessories:

To see the list of currently available Apps and Accessories, execute:

% pacman -Sl hl

hl stands for “headless”, i.e. Apps and Accessories that do not require a display or keyboard attached to the Device, such as web apps.

Interactively creating a new Site with one or more Apps and Accessories

To quickly set up a new Site with one or more Apps and Accessories, execute:

% sudo ubos-admin createsite

To secure this Site with SSL/TLS, invoke it instead as

  • sudo ubos-admin createsite --tls --self-signed (auto-generate a self-signed certificate)

  • sudo ubos-admin createsite --tls --letsencrypt (auto-provision a LetsEncrypt certificate). This only works if your Device is publicly accessible over the internet, and your Site’s hostname as a corresponding public DNS entry. (See also Setting up networking and DNS)

  • sudo ubos-admin createsite --tls (enter key and certificate files manually).

Undeploying one or more Sites

Warning

Undeploying one or more Sites will irrevocably destroy all data managed by the Apps and Accessories of those Sites.

Make sure you do not accidentally undeploy the wrong Site, and always make backups first (see Backup and restore).

Undeploying a single Site

To undeploy a Site with hostname <hostname> after making a backup to file backup.ubos-backup first, execute:

% sudo ubos-admin undeploy --backuptofile backup.ubos-backup --hostname <hostname>

Undeploying all Sites on a Device

To undeploy all Sites currently deployed on a Device at the same time, after making a backup to file backup.ubos-backup first, execute:

% sudo ubos-admin undeploy --backuptofile backup.ubos-backup --all

Use with care.

Note

To skip making a backup during undeploy, leave out the --backupfile <file> arguments.

Updating your Device

Warning

Always back up your Device first.

To update all code on your Device to the most recent UBOS version, execute:

% sudo ubos-admin update

Note

You are advised to read Release Notes first, because sometimes there are extra steps that need to be taken.

Performing backups

To create an all-in-one backup of all Sites currently deployed on your Device to local file backup.ubos-backup, execute:

% sudo ubos-admin backup --backuptofile backup.ubos-backup

To back up a single Site with hostname <hostname> currently deployed on your Device to local file backup.ubos-backup, execute:

% sudo ubos-admin backup --backuptofile backup.ubos-backup --hostname <hostname>