Summary of the setup

In brief:

• Download a virtual machine and run it in VirtualBox. It has all the tools you are going to need pre-installed – build tools, git, IDE etc.

• In the virtual machine, run a single script to customize your setup for different types of things you might want to develop on UBOS.

Easy, right?

Prerequisites: install VirtualBox

1. Download and install VirtualBox if you have not done so already.

Steps in detail

1. Download the virtual appliance file. To do so, go to https://depot.ubosfiles.net/yellow/x86_64/images/index.html and look for a file whose name starts with ubosdev and has extension .ova.

2. In VirtualBox, select “File” / “Import Appliance…”

3. Source: “Local File System” and then select the downloaded .ova file. Select “Next”.

4. Select “MAC Address Policy:” “Generate new MAC addresses for all network adapters” and “Import hard drives as VDI”. Select “Finish”.

5. Importing the appliance will take a little bit of time. It will show up in the list of VMs as ubosdev or such.

6. Start the VM.

7. Logon as ubosdev, there is no password. root does not have a password either: we assume that’s safe enough on your computer. If you don’t think so, set one :-)

8. Pick a better screen resolution:

   • In “Search”, type “Settings” and run it.
   • If there’s an error message saying “Network Unavailable” and “Error: NetworkManager not running”: ignore it, we are not running Network Manager but systemd-networkd.
   • Select “Displays” and pick a resolution that makes sense for your computer setup.
   • Close the settings app.

9. In “Search”, type “Console” and run it (you get the “Search” by selecting “Activities” in the menu bar).

10. Update your Arch host to the latest:

    % sudo pacman -Syu
    

    If there are a lot of updates (including the kernel, for example), reboot and resume from here after the system has come back up:

    % sudo systemctl reboot
    

11. Set up the UBOS Gears development environment by running:

    % ubosdev-container setup
    

    This sets up development on the yellow release channel, which is the recommended channel for development.

    This might take 5-30 min, depending on your network, computer and disk speed.

12. Once this command is complete, you can shutdown the VM any time if you like.

Setting up a container for development

You will perform your actual UBOS development in a Linux container that runs UBOS Linux. In this setup, you can have multiple UBOS Linux container templates, and each of them can be instantiated multiple times.

For example, you might have different container templates for the different UBOS Release Channels. This setup so far has only installed one, which is good enough for most purposes.

To determine which container templates you have available (that depends on the previous step):

% ubosdev-container list-templates

Instantiate one of the available templates into a container to be used for development, such as:

% ubosdev-container create --name ubosdev-yellow --template ubos-develop-yellow

You can instantiate this template multiple times, in case you have multiple workstreams going and want to keep them separate. In this tutorial, we only instantiate one template once.

Ongoing development work

1. Run your Arch Linux development VM in VirtualBox.

2. To determine which UBOS Linux containers you have:

   % ubosdev-container list
   

3. Inside your VirtualBox development VM, run your UBOS Linux container:

   % ubosdev-container run --name <name>
   

   where <name> is the name of an available container, e.g. ubosdev-yellow.

   This gives you console access to the container. This command is simply a wrapper around the systemd-nspawn command with options that are useful. You could run it directly, too.

   You shut down the container with 3 quick ^]s in the primary container console.

4. To open up a non-root shell inside your development container, if ubosdev-yellow is the name of your container, open a new terminal and execute:

   % sudo machinectl shell ubosdev@ubosdev-yellow
   

   This essentially does the same thing as if you were to log into your container as user ubosdev from the console or via ssh, but you don’t need to have any credentials set up.

5. When you run the container with ubosdev-container run, your home directory on your Arch Linux host will be the same as the home directory of the ubosdev user in the UBOS Linux container. This makes development much simpler because you can edit files either on the host or in the container; they are the same.

6. To edit your code, two IDEs are pre-installed on the Arch Linux host:

   • geany is a general-purpose IDE;
   • netbeans is an IDE particularly suitable for Java development.

   Of course, you can install others from the Arch repositories or directly.

7. You can connect to a Site running inside the UBOS Linux development container by using the container’s name as the hostname in the URL. So if one of your running containers is named ubosdev-yellow, typing http://ubosdev-yellow/ into your browser on the Arch Linux host will talk to the web server in your container. Firefox is pre-installed on the Arch Linux host.