Setting up your first Site and App

/docs/gears/firstsite/

Follow these steps:

  1. Decide which web App to install. You can find the current set of available Apps and Accessories by executing:

    % pacman -Sl hl
    

    In this example, we’ll use Wordpress.

  2. Decide at which hostname you’d like to run the App. In this example, we’ll use host * and run Wordpress at Context Path /blog. By specifying *, meaning “any”, you have the most choices for which URL will work in your browser to access your new Wordpress installation:

    • You can use the IP address of your Device. For example, if the IP address is 192.168.1.10, Wordpress will be reachable at http://192.168.1.10/blog/

    • UBOS physical devices like PCs and Raspberry Pis (not containers or cloud) use mDNS to advertise themselves on the local network. The name depends on the type of device:

      • if installed on a PC, Wordpress will be reachable at http://ubos-pc.local/blog/

      • if installed on a Raspberry Pi, Wordpress will be reachable at http://ubos-raspberry-pi.local/blog/

      Unfortunately that only works on older versions of Windows if you have iTunes installed. It should work on all other devices out of the box, including Macs, Linux PCs, iOS and Android devices, and PCs running more recent versions of Windows.

    • If your Device has an official DNS entry on its own, you should use this one, because it gives you the opportunity to run multiple Sites, with their own distinct Apps on the same Device, just like web hosting companies do with virtual hosting. This is the recommended option for running UBOS in the cloud.

    • If you are just trying out UBOS, you can fake an official DNS entry by editing your /etc/hosts file on your workstation (not the Device).

    See also Setting up networking and DNS.

  3. Execute the following command:

    % sudo ubos-admin createsite
    

    This command will ask a number of questions. Once you have answered them, it will appear to think for a while and then set up your new App.

    For the name of the app, and names of accessories, use the package names shown in the output of the pacman -Sl hl command above.

    Here is an example transcript:

    % sudo ubos-admin createsite
    ** First a few questions about the website that you are about to create:
    Hostname (or * for any): *
    Site admin user id (e.g. admin): admin
    Site admin user name (e.g. John Doe): admin
    Site admin user password (e.g. s3cr3t):
    Repeat site admin user password:
    Site admin user e-mail (e.g. foo@bar.com): root@localhost
    ** Now a few questions about the app(s) you are going to deploy to this site:
    First app to run (or leave empty when no more apps): wordpress
    Downloading packages...
    App wordpress suggests context path /blog
    Enter context path: /blog
    Any accessories for wordpress? Enter list:
    Next app to run (or leave empty when no more apps):
    Downloading packages...
    Deploying...
    Installed site sebbab46f26af24d677c955aabed8ae4e0186d4fc at http://*/
    
  4. Access your new App. You can reach it directly by visiting the correct URL as described above. If you installed Wordpress as in the transcript above, and when accessing it with your web browser leave out the trailing /blog/, you will see the list of Apps installed at this Site. Currently that is only Wordpress at path /blog/. If you had continued entering additional Apps in response to the question “Next app to run”, UBOS would have installed more Apps that would show up here.

If you are curious what UBOS just did under the hood, please refer to Command: ubos-admin createsite.