• Documentation
  • Blog
  • Release Notes
  • Glossary
  • FAQs
  • @[email protected]
UBOS logo

Documentation

  1. UBOS Apps
    1. Notes on amazonses
    2. Notes on docroot
    3. Notes on Mastodon
    4. Notes on Nextcloud
    5. Notes on Redirect
    6. Notes on Wordpress
  2. UBOS PeerGraph
  3. UBOS Gears
    1. Setting up your first Site and App
    2. Setting up networking and DNS
    3. How to create a website secured by SSL/TLS
    4. Managing Sites and Apps
    5. Backup and restore
    6. Upgrading and keeping UBOS current
    7. The UBOS Staff
    8. Device-specific Notes
      1. ESPRESSObin
      2. Raspberry Pi
    9. Advanced management
      1. Enabling non-standard package repositories
      2. Migrating from one App to another
      3. Pinning resources
    10. ubos-admin Command reference
    11. FAQ, HOWTOs and Troubleshooting
      1. Doesn’t apt / dpkg / yum / pacman etc. does what UBOS Gears does already?
      2. Doesn’t puppet / chef / ansible etc. does what UBOS Gears does already?
      3. Doesn’t Docker do what UBOS Gears does already?
      4. Is it possible to run UBOS Gears or UBOS PeerGraph on an operating system other than UBOS Linux?
      5. “Package not found error” when installing a new App or Accessory
      6. A UBOS container comes up degraded
      7. Booting UBOS on a PC starts out fine, but then the screen goes blank
      8. Can I manage apps packaged as Docker containers with UBOS?
      9. Can I run UBOS in a Docker container?
      10. Can I use UBOS without purchasing a domain name?
      11. Cannot access MySQL database. File missing: /etc/mysql/root-defaults-ubos.cnf
      12. Cannot boot UBOS from boot stick on a PC
      13. Cannot connect to the public internet from a UBOS container
      14. Cannot create a temporary backup; the backup directory is not empty
      15. Failed to create file /sys/devices/system/cpu/microcode/reload
      16. How are the various UBOS images different from each other?
      17. How can I install more than one web App on the same Device?
      18. How do I set up WiFi?
      19. How to enable non-standard Package Repositories
      20. How to get help
      21. How to log into your UBOS Device
      22. How to modify the configuration of your Site
      23. How to report a bug or issue
      24. How to use Pagekite to reach your UBOS Device behind a firewall
      25. How to use SSH
      26. I need a Package that isn’t in UBOS
      27. I need root
      28. I own a domain name, and I’d like to use it for my UBOS Device. How do I do that?
      29. I want to move from one device to another, or from/to the cloud to/from a device
      30. I want to run ssh on a non-standard port
      31. I’m running out of disk space, what now?
      32. Installing a new Package or updating fails with a message about “invalid or corrupted package” or “key is disabled”
      33. Installing a new Package or upgrading fails with a message about “unknown trust”
      34. Is it safe to have my Site accessible from the public web?
      35. My non-English keyboard layout is all screwed up
      36. My SD card is much larger than the UBOS image. How do I use the rest of the space?
      37. Nothing happens when UBOS is supposed to be booting
      38. Problems with “IPv6 Packet Filtering Framework”
      39. UBOS is in a “degraded” state
      40. ubos-admin status reports “Systemd unit … has failed”
      41. Verify your downloaded UBOS image
      42. What is the default “root” password?
      43. What text editor can I use on UBOS?
      44. Why did you derive UBOS Linux from Arch Linux, and what is the relationship between UBOS Linux and Arch?
      45. Why is it called UBOS?
      46. Writing a disk image to a USB stick or SD card
        1. Writing an image to a USB stick or SD card on Linux
        2. Writing an image to a USB stick or SD card on macOS
        3. Writing an image to a USB stick or SD card on Windows
    12. UBOS Gears developer documentation
      1. UBOS Gears developer setup
        1. Developing on an Arch Linux workstation
        2. Developing on an Ubuntu Linux workstation
        3. Developing using Arch Linux with a systemd-nspawn container using VMWare Fusion on Apple Silicon
      2. Build and run your first UBOS standalone App
      3. How to package UBOS standalone Apps built with a variety of languages
        1. Hello World
        2. Glad-I-Was-Here (PHP, Mariadb)
        3. An Accessory for Glad-I-Was-Here (PHP, Mariadb)
        4. Glad-I-Was-Here (PHP, Postgresql)
        5. Glad-I-Was-Here (Python, Mariadb)
      4. Middleware-specific notes
        1. Node.js notes
        2. SMTP notes
      5. UBOS Gears Reference
        1. UBOS Manifest
          1. Structure of the UBOS Manifest
          2. Info section
          3. Roles section
          4. Customization points section
          5. Appinfo section
          6. Accessoryinfo section
          7. Variables available at deploy or undeploy
          8. Functions that may be applied to variables
          9. Creating random values
          10. Scripts in UBOS Manifests
        2. Site JSON
        3. A complex deployment example
        4. UBOS Networking
        5. Allocating and opening up non-default ports
        6. Logging
        7. UBOS state
        8. UBOS Backup format
        9. Format of the App Status JSON
      6. Understanding ubos-admin
        1. Command: ubos-admin backup
        2. Command: ubos-admin backupinfo
        3. Command: ubos-admin createsite
        4. Command: ubos-admin deploy
        5. Command: ubos-admin hostid
        6. Command: ubos-admin init-staff
        7. Command: ubos-admin list-data-transfer-protocols
        8. Command: ubos-admin listnetconfigs
        9. Command: ubos-admin listsites
        10. Command: ubos-admin read-configuration-from-staff
        11. Command: ubos-admin restore
        12. Command: ubos-admin setnetconfig
        13. Command: ubos-admin setup-shepherd
        14. Command: ubos-admin showappconfig
        15. Command: ubos-admin shownetconfig
        16. Command: ubos-admin showsite
        17. Command: ubos-admin status
        18. Command: ubos-admin undeploy
        19. Command: ubos-admin update
        20. Command: ubos-admin write-configuration-to-staff
      7. Potentially useful infrastructure for standalone Apps
        1. The UBOS rsync server
  4. UBOS Linux
    1. Installation
      1. Run UBOS on an x86_64 PC
      2. Run UBOS from a boot stick on a x86_64 PC
      3. Run UBOS in an x86_64 VirtualBox virtual machine
      4. Run UBOS in an x86_64 VMWare Workstation virtual machine
      5. Run UBOS on an x86_64 Amazon Web Services EC2 virtual server
      6. Run UBOS in a Linux container on an x86_64 PC
      7. Run UBOS on Raspberry Pi 5
      8. Run UBOS on ESPRESSObin
      9. Run UBOS in an ARM aarch64 Linux container