This site requires (a little bit of) Javascript.
Documentation Overview
Operation documentation
Installation
Run UBOS on a PC (64bit)
Run UBOS from a boot stick on a PC (64bit)
Run UBOS in a VirtualBox virtual machine (64bit)
Run UBOS on an Amazon Web Services EC2 virtual server
Run UBOS on Raspberry Pi 5
Run UBOS on ESPRESSObin
Run UBOS in a Linux container on a PC (64bit)
Run UBOS in an
aarch64
Linux container
Setting up your first Site and App
Setting up networking and DNS
How to create a website secured by SSL/TLS
Managing Sites and Apps
Backup and restore
Upgrading and keeping UBOS current
The UBOS Staff
App-specific notes
Reliably send e-mail via Amazon Web Services’ Simple E-mail Service: amazonses
Static website hosting with rsync-based upload: docroot
Notes on Mastodon
Notes on Nextcloud
Notes on Redirect
Notes on Wordpress
Device-specific Notes
ESPRESSObin
Raspberry Pi
Advanced management
Enabling non-standard package repositories
Migrating from one App to another
Pinning resources
Command reference
FAQ, HOWTOs and Troubleshooting
“Package not found error” when installing a new App or Accessory
A UBOS container comes up degraded
Booting UBOS on a PC starts out fine, but then the screen goes blank
Can I run UBOS in a Docker container?
Can I use UBOS without purchasing a domain name?
Cannot access MySQL database. File missing: /etc/mysql/root-defaults-ubos.cnf
Cannot boot UBOS from boot stick on a PC
Cannot connect to the public internet from a UBOS container
Cannot create a temporary backup; the backup directory is not empty
Failed to create file /sys/devices/system/cpu/microcode/reload
How are the various UBOS images different from each other?
How can I install more than one web App on the same Device?
How do I set up WiFi?
How to enable non-standard Package Repositories
How to get help
How to log into your UBOS Device
How to modify the configuration of your Site
How to report a bug or issue
How to use Pagekite to reach your UBOS Device behind a firewall
How to use SSH
I need a Package that isn’t in UBOS
I need root
I own a domain name, and I’d like to use it for my UBOS Device. How do I do that?
I want to move from one device to another, or from/to the cloud to/from a device
I want to run ssh on a non-standard port
I’m running out of disk space, what now?
Installing a new Package or updating fails with a message about “invalid or corrupted package” or “key is disabled”
Installing a new Package or upgrading fails with a message about “unknown trust”
Is it safe to have my Site accessible from the public web?
My non-English keyboard layout is all screwed up
My SD card is much larger than the UBOS image. How do I use the rest of the space?
Nothing happens when UBOS is supposed to be booting
Problems with “IPv6 Packet Filtering Framework”
UBOS is in a “degraded” state
ubos-admin status reports “Systemd unit … has failed”
Verify your downloaded UBOS image
What is the default “root” password?
What text editor can I use on UBOS?
Why did you derive UBOS Linux from Arch Linux, and what is the relationship between UBOS Linux and Arch?
Why is it called UBOS?
Writing a disk image to a USB stick or SD card
Writing an image to a USB stick or SD card on Linux
Writing an image to a USB stick or SD card on macOS
Writing an image to a USB stick or SD card on Windows
Developer documentation
Developer setup
Developing using Arch Linux on VirtualBox
x86_64
with a systemd-nspawn container
Developing using a UTM Arch Linux VM on Apple Silicon computers with UBOS in a systemd-nspawn container
Alternate developer setups
Developing using a systemd-nspawn container (Linux host only)
Developing using Arch Linux using Parallels on Apple Silicon with a systemd-nspawn container
Developing using a UTM Arch Linux VM on Apple
x86_64
computers with UBOS in a systemd-nspawn container
Developer tutorials for standalone UBOS apps (not UBOS Mesh)
Build and run your first UBOS standalone App
How to package UBOS standalone Apps built with a variety of languages
Hello World
Glad-I-Was-Here (PHP, Mariadb)
An Accessory for Glad-I-Was-Here (PHP, Mariadb)
Glad-I-Was-Here (PHP, Postgresql)
Glad-I-Was-Here (Python, Mariadb)
UBOS Gears Reference
UBOS Manifest
Structure of the UBOS Manifest
Info section
Roles section
Customization points section
Appinfo section
Accessoryinfo section
Variables available at deploy or undeploy
Functions that may be applied to variables
Creating random values
Scripts in UBOS Manifests
Site JSON
A complex deployment example
UBOS Networking
Allocating and opening up non-default ports
Logging
UBOS state
UBOS Backup format
Format of the App Status JSON
Testing standalone Apps with “webapptest”
Understanding ubos-admin
Command: ubos-admin backup
Command: ubos-admin backupinfo
Command: ubos-admin createsite
Command: ubos-admin deploy
Command: ubos-admin hostid
Command: ubos-admin init-staff
Command: ubos-admin list-data-transfer-protocols
Command: ubos-admin listnetconfigs
Command: ubos-admin listsites
Command: ubos-admin read-configuration-from-staff
Command: ubos-admin restore
Command: ubos-admin setnetconfig
Command: ubos-admin setup-shepherd
Command: ubos-admin showappconfig
Command: ubos-admin shownetconfig
Command: ubos-admin showsite
Command: ubos-admin status
Command: ubos-admin undeploy
Command: ubos-admin update
Command: ubos-admin write-configuration-to-staff
Release channels and UBOS release process
Miscellaneous
Potentially useful infrastructure for standalone Apps
The UBOS rsync server
Middleware-specific notes
Node.js notes
SMTP notes
Setting up an Arch Linux system as a UBOS development system
How to create a UBOS development VM for VirtualBox on
x86_64
How to create a UBOS development VM for UTM on
x86_64
Apple computers
How to create a UBOS development VM for UTM on Apple Silicon computers
How to create a UBOS development VM for Parallels Desktop on Apple Silicon computers
Creating cloud images
Amazon Web Services EC2
Developer FAQ
Doesn’t apt / dpkg / yum / pacman etc. does what UBOS Gears does already?
Doesn’t puppet / chef / ansible etc. does what UBOS Gears does already?
Doesn’t Docker do what UBOS Gears does already?
Is it possible to run UBOS Gears or Mesh on an operating system other than UBOS Linux?
Can I manage apps packaged as Docker containers with UBOS?
Architecture
Glossary
Accessory
App
AppConfigId
AppConfigItem
AppConfiguration
Arch
Arch Linux
Attribute
blessing
Bot
Context Path
Customization Point
Data Transfer Protocol
Deployment
Depot
Device
Device Class
diet4j module framework
EntityType
Flock
Gradle
Handlebars
History
Home Server
HostId
Hostname
IDE
Installation
LetsEncrypt
mDNS
MeshBase
MeshObject
MeshObjectIdentifier
MeshType
MeshTypeIdentifier
Middleware
Model
Network Configuration
Package
Pagekite
Parallels Desktop
Personal Server
PKGBUILD
Property
PropertyType
Relationship
RelationshipType
Release Channel
Repository
Retention Bucket
Role
RoleAttribute
RoleProperty
RoleType
Rolling Release
Shepherd
Site
Site JSON
Site JSON Template
SiteId
Transaction
Transaction Log
UBOS Gears
UBOS Linux
UBOS Manifest
UBOS Mesh
UBOS Mesh code generator
UBOS Project
UBOS Staff
unblessing
UTM
VirtualBox
VMWare
Wildcard hostname
Top
Documentation
Developers
Miscellaneous
Middleware-specific notes
Middleware-specific notes
/docs/development/misc/middleware-notes/
Node.js notes
SMTP notes