• Stars
    star
    504
  • Rank 87,537 (Top 2 %)
  • Language
    JavaScript
  • License
    GNU General Publi...
  • Created almost 8 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A simple tool to install Ubuntu Touch on UBports devices

UBports Installer Continuous Integration snap codecov

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 logo   Linux mac logo   macOS windowslogo   Windows
snap
snap install ubports-installer
AppImage
deb
dmg exe

Troubleshooting

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. Use the Report a bug button directly in the installer to generate a template for a bugreport with all the important metadata automatically filled out.

Config files

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.yml 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.

Logs

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.

Set up for development

Ensure you have properly installed nodejs and npm.

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

npm install

Run with npm

$ npm start -- -h
Usage: npm start -- [-f <file>] [-v[v] [-d]

UBports Installer (0.7.2-beta) source for linux
GPL-3.0 UBports Foundation <[email protected]>
The easy way to install Ubuntu Touch on UBports devices. A friendly cross-platform Installer for Ubuntu Touch. Just connect a supported device to your PC, follow the on-screen instructions and watch this awesome tool do all the rest.
https://devices.ubuntu-touch.io

Options:
  -V, --version        output the version number
  -f, --file <file>    Override the official config by loading a YAML local file
  -v, --verbose        Print debugging information. Multiple -v options increase the verbosity
  -d, --debug          Enable electron's web debugger to inspect the frontend (default: false)
  --systemimage <url>  Set a custom systemimage server url (default:
                       "https://system-image.ubports.com/")
  -h, --help           display help for command

Lint

Before filing a PR, please make sure you follow our coding style by running npm run lint.

Build packages

$ ./build.js --help
Usage: ./build.js -o <os> -p <package> -a <arch> [options]

Options:
  -V, --version                output the version number
  -o, --os <os>                Target operating system (darwin, win32, linux) (default: "linux")
  -p, --package <package>      Target package (deb, snap, AppImage, dmg, portable, dir) (default: "dir")
  -a, --arch <architecture>    Target architecture (armv7l, x64, ia32, arm64) (default: "x64")
  -e, --extra-metadata [JSON]  extra data for package.json (default: "{}")
  -h, --help                   output usage information

Libraries

The UBports Foundation maintains a various free- and open-source NPM libraries for the UBports Installer.

Package Version Description
progressive-downloader version Parallel downloads and opportunistic checksum verification
promise-android-tools version Extensive wrapper for ADB, Fastboot, Heimdall
android-tools-bin version Cross-platform binaries for ADB, Fastboot, Heimdall
open-cuts-reporter version Report test results to UBports OPEN-CUTS

License

Original development by Marius Gripsgård and Johannah Sprinz. Copyright (C) 2017-2022 UBports Foundation.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

More Repositories

1

ubuntu-touch

Ubuntu Touch's issue inbox is now migrated to GitLab.
1,281
star
2

unity8

The operating environment for everywhere.
QML
718
star
3

docs.ubports.com

UBports Documentation
HTML
71
star
4

ubuntu-touch-for-oneplus-one

Ubuntu touch for oneplus one
Shell
67
star
5

unity8-desktop-install-tools

Shell
65
star
6

installer-configs

Install configurations for the UBports Installer
JavaScript
55
star
7

telegram-app

Unofficial Telegram App for Ubuntu Desktop & Mobile
C++
54
star
8

morph-browser

Moved to https://gitlab.com/ubports/core/morph-browser
QML
45
star
9

ubports-pdk

Platform Development Kit for Ubuntu Touch
Shell
39
star
10

porting-notes

A repo to keep in-progress device ports information and information useful to porters that is not in official docs yet
38
star
11

utqemu

Ubuntu touch qemu virtual machine
Shell
37
star
12

ubports.com

The UBports website
21
star
13

promise-android-tools

A wrapper for adb and fastboot that returns convenient promises.
TypeScript
20
star
14

messaging-app

Messaging App for Ubuntu Touch devices. Moved to GitLab.
QML
19
star
15

dialer-app

Dialer app for Ubuntu Touch devices. Migrated to GitLab.
QML
19
star
16

mir

Migrated to https://gitlab.com/ubports/development/core/packaging/mir
C++
17
star
17

devices

Outdated manifests, use devices.xml at https://github.com/ubports/build-scripts
14
star
18

qqc2-suru-style

Suru style for QtQuick Controls 2. Migrated to https://gitlab.com/ubports/core/qqc2-suru-style
QML
14
star
19

android

13
star
20

ubuntu-ui-toolkit

Moved to https://gitlab.com/ubports/core/lomiri-ui-toolkit
C++
13
star
21

terminal-app

Moved to GitLab
C++
13
star
22

crossbuilder

A debian package cross building tool using LXD
Shell
12
star
23

address-book-app

Moved to GitLab: https://gitlab.com/ubports/core/address-book-app
QML
12
star
24

wiki.ubports.com

Deprecated wiki - replaced by https://docs.ubports.com
12
star
25

raspberry-pi

For UBports Raspberry Pi Port head over to Gitlab
11
star
26

camera-app

Moved to GitLab
QML
10
star
27

android_device_fairphone_fp2

Shell
10
star
28

keyboard-component

Moved to https://gitlab.com/ubports/core/lomiri-keyboard
QML
9
star
29

aethercast

Migrated to https://gitlab.com/ubports/development/core/aethercast
C++
9
star
30

device-files

[Depricated] use ubuntu-overlay
C
9
star
31

system-settings

Moved to https://gitlab.com/ubports/core/lomiri-system-settings
C++
9
star
32

devices.ubports.com

The old ubuntu touch devices website, no longer in use
JavaScript
8
star
33

halium_bootable_recovery

The Ubuntu Touch recovery for Halium ports
C++
8
star
34

music-app

Moved to GitLab
QML
8
star
35

filemanager-app

Moved to GitLab
C++
8
star
36

upstart

C
7
star
37

build-tools

Scripts used by the UBports jenkins server
Shell
7
star
38

ubuntu-push

Moved to https://gitlab.com/ubports/core/lomiri-push-service
Go
7
star
39

deviceinfo

Library to detect and configure devices. Moved to https://gitlab.com/ubports/core/deviceinfo
C++
7
star
40

calendar-app

Moved to GitLab
QML
6
star
41

blog.ubports.com

The old UBports blog
HTML
6
star
42

telepathy-ofono

Migrated to https://gitlab.com/ubports/development/core/telepathy-ofono
C++
6
star
43

qtmir

Moved to https://gitlab.com/ubports/core/qtmir/
C++
6
star
44

mir-android-platform

Graphics platform for the Mir display server to enable the display server on android drivers through the libhybris library. Moved to https://gitlab.com/ubports/core/hybris-support/mir-android-platform
C++
6
star
45

ubuntu-touch.io

A website about Ubuntu Touch.
Pug
5
star
46

ubuntu-touch-meta

Shell
5
star
47

device-builds

This is the build scrips that is used on the ubports build server
Shell
5
star
48

clock-app

Moved to GitLab
QML
5
star
49

lxc-android-config

Moved to https://gitlab.com/ubports/core/hybris-support/lxc-android-config
Shell
5
star
50

qtubuntu

Moved to https://gitlab.com/ubports/core/qtubuntu
C++
4
star
51

ubuntu-themes

Moved to https://gitlab.com/ubports/core/suru-icon-theme
CSS
4
star
52

ofono

oFono is a free software project for mobile telephony (GSM/UMTS) applications. It is built on 3GPP standards and uses a high-level D-Bus API for use by telephony applications.
C
4
star
53

ubports-boot

Shell
4
star
54

docviewer-app

Moved to GitLab
C++
4
star
55

unity-system-compositor

Moved to https://gitlab.com/ubports/core/lomiri-system-compositor
C++
4
star
56

libhybris

Moved to https://gitlab.com/ubports/core/packaging/libhybris
C
3
star
57

unity8-desktop-session

Shell
3
star
58

telephony-service

Migrated to https://gitlab.com/ubports/development/core/telephony-service
C++
3
star
59

location-service

Moved to GitLab: https://gitlab.com/ubports/core/location-service
C++
3
star
60

ubuntu-touch-sounds

Moved to https://gitlab.com/ubports/core/ubuntu-touch-sounds
3
star
61

ubuntu-printing-app

An application which takes a PDF as input and then outputs it to CUPS
QML
3
star
62

indicator-datetime

The "Time & Date" indicator for Ubuntu Touch. No longer maintained. See https://github.com/AyatanaIndicators/ayatana-indicator-datetime
C++
3
star
63

devices.ubuntu-touch.io

Moved to gitlab
HTML
3
star
64

ubuntu_kernel_xenial

C
3
star
65

hfd-service

Moved to https://gitlab.com/ubports/core/hfd-service
C++
3
star
66

xmir

C
3
star
67

webbrowser-app

Replaced by https://github.com/ubports/morph-browser
QML
3
star
68

mediaplayer-app

Media Player application for Ubuntu Touch devices. Migrated to https://gitlab.com/ubports/core/mediaplayer-app
QML
3
star
69

miral

C++
2
star
70

weather-app

Moved to GitLab
QML
2
star
71

sync-monitor

In charge of various sync activities on Ubuntu Touch. Migrated to https://gitlab.com/ubports/core/sync-monitor
C++
2
star
72

buteo-syncfw

Migrated to https://gitlab.com/ubports/development/core/packaging/buteo-syncfw
C++
2
star
73

unity-webapps-qml

JavaScript
2
star
74

system-image

Moved to https://gitlab.com/ubports/core/system-image
Python
2
star
75

ubuntu-html5-theme

HTML
2
star
76

libsdl2

C
2
star
77

stats.ubports.com

See how many active devices are running Ubuntu Touch
JavaScript
2
star
78

unity-api

Moved to https://gitlab.com/ubports/core/lomiri-api
C++
2
star
79

ubuntu-touch-session

Moved to https://gitlab.com/ubports/core/ubuntu-touch-session
Shell
2
star
80

livecd-rootfs

Shell
2
star
81

kernel_turbo

Linux kernel for Meizu PRO 5 Ubuntu Edition
C
2
star
82

qtwebengine-opensource-src-packaging

Moved to GitLab
2
star
83

unity8-build

Shell
2
star
84

sqlite-icu-extension

ICU extension for SQLite (needed by qtcontacts-sqlite)
C++
2
star
85

qtpim-opensource-src-packaging

Moved to GitLab
2
star
86

trust-store

Moved to GitLab: https://gitlab.com/ubports/core/trust-store
C++
2
star
87

libindicator

A set of symbols and convience functions that all indicators would like to use.
C
2
star
88

gallery-app

Moved to GitLab
C++
2
star
89

history-service

Moved to https://gitlab.com/ubports/core/history-service
C++
2
star
90

initramfs-tools-ubuntu-touch

Migrated to https://gitlab.com/ubports/development/core/initramfs-tools-ubuntu-touch
Shell
2
star
91

pulseaudio-packaging

Moved to https://gitlab.com/ubports/core/packaging/pulseaudio
1
star
92

wayland

Vendored backported Wayland
C
1
star
93

repowerd

Moved to https://gitlab.com/ubports/core/repowerd
C++
1
star
94

unity-scopes-api

C++
1
star
95

qtorganizer5-eds

Migrated to https://gitlab.com/ubports/core/qtorganizer5-eds
C++
1
star
96

pay-service

pay-service has been unused for a long time
Go
1
star
97

goget-ubuntu-touch

Go
1
star
98

kernel_krillin

Linux kernel for BQ Aquaris E4.5 Ubuntu Edition
C
1
star
99

buteo-syncfw-qml

Migrated to https://gitlab.com/ubports/development/core/packaging/buteo-syncfw-qml
C++
1
star
100

buteo-sync-plugin-carddav

CardDav plugin for Buteo
C++
1
star