Fear not! Installing UBports Ubuntu Touch on your device is easy! Just download the UBports Installer package for your operating system and sit back and relax while your computer does all the rest. Installing third-party operating systems has never been so easy!

Linux	macOS	Windows
snap, AppImage, deb	dmg	exe

Troubleshooting information can be found in the docs. If you need help, you can join UBports' support channels on telegram or matrix or ask a question in the forum or on askubuntu. If you believe that the UBports Installer is not working correctly, you can also file a new issue to help us solve the problem. As a last resort, we also have manual installation instructions for every device, that you can follow if you want to install without using the UBports Installer.

By default, the Installer will always use the latest version of the installation configuration files available. Should you want to specify a custom config file, you can do that by starting the Installer with the -f ./path/to/config.json argument. This can be used to test changes to the configuration or even to add new devices to the installer. The structure of the config files is specified here.

If the installer runs into an error, it will usually present you with the option to create a bug report. It is always a good idea to make use of that feature, because that way the developers will almost always have all the information they need to help you. If you still have to look at the log file for some reason, you can find it in ~/.cache/ubports/ubports-installer.log on linux (or ~/snap/ubports-installer/current/.cache/ubports/ubports-installer.log if you're using the snap package). On Windows, it will be located at %APPDATA%\ubports\ubports-installer.log and on macOS you can find it under $HOME/Library/Caches/ubports/ubports-installer.log.

git clone https://github.com/ubports/ubports-installer.git
cd ubports-installer
./setup-dev.sh

$ npm start -- -h
Usage: ubports-installer [options]

Options:
  -V, --version                               output the version number
  -s, --settings "<setting>: <value>[, ...]"  [experimental] Override install settings
  -f, --file <file>                           [experimental] Override the config by loading a file
  -v, --verbose                               Enable verbose logging
  -D, --debug                                 Enable debugging tools and verbose logging
  -h, --help                                  output usage information

Before filing a PR, please make sure you follow our coding style. Just run npm lint to see if there are any problems. If there are, it might even be possible to fix them automatically by running npm lint-fix.

npm run-script dist:linux
npm run-script dist:mac
npm run-script dist:win