Jump to content

Installing packages on a running phone: Difference between revisions

From postmarketOS Wiki
No edit summary
Knuxify (talk | contribs)
m fix syntax highlighting error
 
(22 intermediate revisions by 10 users not shown)
Line 1: Line 1:
This article explains how to host packages that were built with [[pmbootstrap]] in a local network, so you can install them on your phone via Wi-Fi or USB network.
{{warning|Do not install suspicious apk packages from unknown sources!}}


== Easiest way: use pmbootstrap sideload ==
This article explains how to install packages that were built with [[pmbootstrap]] on your phone via Wi-Fi or USB network.
Connect your phone using USB network and make sure you can login into it with SSH. Then excecute the following:
 
== pmbootstrap sideload ==
{{note|If you want to sideload an application to test a pmaports or aports merge request, [[Mrtest]] is probably more convenient.}}
 
This method copies a package via SSH to your phone and installs it. It makes installing a single package relatively easy. If you need to install multiple packages with dependencies on each other, hosting a repository locally (see below) is recommended instead.
 
Connect your phone using [[USB Network]] (or Wi-Fi) and make sure you can login into it with SSH. Then excecute the following:
<syntaxhighlight lang="shell-session">
<syntaxhighlight lang="shell-session">
ps:~$ pmbootstrap sideload --host 172.16.42.1 --port 22 --user user --arch <arch> package-name
pc:~$ pmbootstrap sideload --host 172.16.42.1 --user user --arch <arch> package-name
</syntaxhighlight>
</syntaxhighlight>
replace ''arch''  with actual architecture (for example, aarch64).
replace ''arch''  with actual architecture (for example, aarch64).
Line 10: Line 16:
Add <code>--install-key</code> argument if you see the error about untrusted signature.
Add <code>--install-key</code> argument if you see the error about untrusted signature.


== Hard way: host repository locally using a web server ==
Add <code>--port NUM</code> if your device's SSH server is running on a non-standard port (not 22). This may be needed for example, for an image that is running using '''pmbootstrap qemu''' (see [[QEMU]]).
 
For Wi-Fi use your device's Wi-Fi IP address.
 
== Host repository locally using a web server ==
This method is easier when you need to install multiple dependent packages at once, or simulate the regular upgrade process from repositories. For single packages, <code>pmbootstrap sideload</code> is probably easier, see above.
 
==== Start the webserver ====
==== Start the webserver ====
===== Python http.server =====
Go to the pmbootstrap packages dir and start a web server:
Go to the pmbootstrap packages dir and start a web server:


<syntaxhighlight lang="shell-session">
<syntaxhighlight lang="shell-session">
pc:~$ cd ~/.local/var/pmbootstrap/packages/stable && python3 -m http.server
pc:~$ cd ~/.local/var/pmbootstrap/packages/edge && python3 -m http.server
</syntaxhighlight>
</syntaxhighlight>
===== Nginx =====
See [[Host a reverse_proxy to postmarketOS and Alpine_Repositories#Local repository server]]


==== Add the repository ====
==== Add the repository ====
Install your favorite editor and open <code>/etc/apk/repositories</code> on your phone via [[SSH]]:
Install your favorite editor and open <code>/etc/apk/repositories</code> on your phone via [[SSH]]:


<source lang="shell-session">
<syntaxhighlight lang="shell-session">
phone:~$ sudo apk add neovim
phone:~$ sudo apk add neovim
phone:~$ sudo nvim /etc/apk/repositories
phone:~$ sudo nvim /etc/apk/repositories
</source>
</syntaxhighlight>


Add your own repository on top:
Add your own repository on top:
<source lang="shell">
<syntaxhighlight lang="text">
http://172.16.42.2:8000
http://172.16.42.2:8000


Line 33: Line 50:
http://dl-cdn.alpinelinux.org/alpine/v3.12/main
http://dl-cdn.alpinelinux.org/alpine/v3.12/main
http://dl-cdn.alpinelinux.org/alpine/v3.12/community
http://dl-cdn.alpinelinux.org/alpine/v3.12/community
</source>
</syntaxhighlight>


==== Copy the package signing keys ====
==== Copy the package signing keys ====
Line 39: Line 56:


On your PC (replace <code>172.16.42.1</code> with the IP of your phone, <code>user</code> with your ssh username, mind the <code>:</code> at the end of the <code>scp</code> command):
On your PC (replace <code>172.16.42.1</code> with the IP of your phone, <code>user</code> with your ssh username, mind the <code>:</code> at the end of the <code>scp</code> command):
<source lang="shell-session">
<syntaxhighlight lang="shell-session">
pc:~$ scp ~/.local/var/pmbootstrap/config_apk_keys/pmos-*.rsa.pub user@172.16.42.1:
pc:~$ scp ~/.local/var/pmbootstrap/config_apk_keys/pmos*.rsa.pub user@172.16.42.1:
pc:~$ ssh user@172.16.42.1
pc:~$ ssh user@172.16.42.1
</source>
</syntaxhighlight>


Run on your phone via SSH:
Run on your phone via SSH:
<source lang="shell-session">
<syntaxhighlight lang="shell-session">
phone:~$ sudo mv pmos-*.rsa.pub /etc/apk/keys/
phone:~$ sudo mv pmos*.rsa.pub /etc/apk/keys/
</source>
</syntaxhighlight>


==== Use your repository ====
==== Use your repository ====
Now <code>apk</code> should recognize your repository, and you should be able to install or upgrade packages built on your PC:
Now <code>apk</code> should recognize your repository, and you should be able to install or upgrade packages built on your PC:


<source lang="shell-session">
<syntaxhighlight lang="shell-session">
phone:~$ sudo apk update
phone:~$ sudo apk update
fetch http://172.16.42.2:8000/aarch64/APKINDEX.tar.gz
fetch http://172.16.42.2:8000/aarch64/APKINDEX.tar.gz
Line 64: Line 81:
OK: 12967 distinct packages available
OK: 12967 distinct packages available
phone:~$ sudo apk upgrade hello-world
phone:~$ sudo apk upgrade hello-world
</source>
</syntaxhighlight>


== pmos-update-kernel ==
== pmos-update-kernel ==
Android devices currently need to run <code>pmos-update-kernel</code> after a kernel upgrade, to actually write the new kernel to the partition expected by LK (see [[Boot_process#LK_.28Android.29|boot process]]).
{{warning|Do not use pmos-update-kernel on '''lk2nd''' devices, such as '''MSM8916''' devices. lk2nd in boot partition will be replaced and the booting will be broken!}}
While devices in main and community categories are expected to update the kernel fully automatically, many Android devices currently need to run <code>pmos-update-kernel</code> after a kernel upgrade, to actually write the new kernel to the partition expected by the bootloader (see [[Boot_process#LK_.28Android.29|boot process]]). You should check the page for your device or it's platform to know if you need this extra step.


==== Run it manually ====
==== Run it manually ====
Install <code>postmarketos-update-kernel</code>, figure out the kernel flavor (in the example below: <code>postmarketos-qcom-msm8974</code>) and update the kernel:
Install <code>postmarketos-update-kernel</code>, figure out the kernel flavor (in the example below: <code>postmarketos-qcom-msm8974</code>) and update the kernel:


<source lang="shell-session">
<syntaxhighlight lang="shell-session">
phone:~$ sudo apk add postmarketos-update-kernel
phone:~$ sudo apk add postmarketos-update-kernel
phone:~$ ls /boot/boot.img-*
phone:~$ ls /boot/boot.img-*
/boot/boot.img-postmarketos-qcom-msm8974
/boot/boot.img-postmarketos-qcom-msm8974
phone:~$ sudo pmos-update-kernel postmarketos-qcom-msm8974
phone:~$ sudo pmos-update-kernel postmarketos-qcom-msm8974
</source>
</syntaxhighlight>


==== Automate with a script ====
==== Automate with a script ====
Line 83: Line 101:


Use this script to automate the steps above (adjust <code>postmarketos-qcom-msm8974</code>!):
Use this script to automate the steps above (adjust <code>postmarketos-qcom-msm8974</code>!):
<source lang="shell">
<syntaxhighlight lang="shell">
#!/bin/sh -ex
#!/bin/sh -ex
# Upgrade all packages (should have your kernel upgrade)
# Upgrade all packages (should have your kernel upgrade)
Line 98: Line 116:
read ans
read ans
test "$ans" = 'y' && sudo reboot
test "$ans" = 'y' && sudo reboot
</source>
</syntaxhighlight>
 
== See also ==
* [[Host a reverse proxy to postmarketOS and Alpine Repositories]]


[[Category:Guide]]
[[Category:Guide]]

Latest revision as of 12:55, 4 June 2024

Warning WARNING: Do not install suspicious apk packages from unknown sources!

This article explains how to install packages that were built with pmbootstrap on your phone via Wi-Fi or USB network.

pmbootstrap sideload

Note If you want to sideload an application to test a pmaports or aports merge request, Mrtest is probably more convenient.

This method copies a package via SSH to your phone and installs it. It makes installing a single package relatively easy. If you need to install multiple packages with dependencies on each other, hosting a repository locally (see below) is recommended instead.

Connect your phone using USB Network (or Wi-Fi) and make sure you can login into it with SSH. Then excecute the following:

pc:~$ pmbootstrap sideload --host 172.16.42.1 --user user --arch <arch> package-name

replace arch with actual architecture (for example, aarch64).

Add --install-key argument if you see the error about untrusted signature.

Add --port NUM if your device's SSH server is running on a non-standard port (not 22). This may be needed for example, for an image that is running using pmbootstrap qemu (see QEMU).

For Wi-Fi use your device's Wi-Fi IP address.

Host repository locally using a web server

This method is easier when you need to install multiple dependent packages at once, or simulate the regular upgrade process from repositories. For single packages, pmbootstrap sideload is probably easier, see above.

Start the webserver

Python http.server

Go to the pmbootstrap packages dir and start a web server:

pc:~$ cd ~/.local/var/pmbootstrap/packages/edge && python3 -m http.server
Nginx

See Host a reverse_proxy to postmarketOS and Alpine_Repositories#Local repository server

Add the repository

Install your favorite editor and open /etc/apk/repositories on your phone via SSH:

phone:~$ sudo apk add neovim
phone:~$ sudo nvim /etc/apk/repositories

Add your own repository on top:

http://172.16.42.2:8000

http://mirror.postmarketos.org/postmarketos/v20.05
http://dl-cdn.alpinelinux.org/alpine/v3.12/main
http://dl-cdn.alpinelinux.org/alpine/v3.12/community

Copy the package signing keys

If you did not generate the postmarketOS installation from the same PC, which is now running pmbootstrap to build the packages you want to install, then you need to copy the package signing keys. Otherwise, apk will refuse to install the packages ("UNTRUSTED signature").

On your PC (replace 172.16.42.1 with the IP of your phone, user with your ssh username, mind the : at the end of the scp command):

pc:~$ scp ~/.local/var/pmbootstrap/config_apk_keys/pmos*.rsa.pub user@172.16.42.1:
pc:~$ ssh user@172.16.42.1

Run on your phone via SSH:

phone:~$ sudo mv pmos*.rsa.pub /etc/apk/keys/

Use your repository

Now apk should recognize your repository, and you should be able to install or upgrade packages built on your PC:

phone:~$ sudo apk update
fetch http://172.16.42.2:8000/aarch64/APKINDEX.tar.gz
fetch http://postmarketos1.brixit.nl/postmarketos/v20.05/aarch64/APKINDEX.tar.gz                                                                  
fetch http://dl-cdn.alpinelinux.org/alpine/v3.12/main/aarch64/APKINDEX.tar.gz                                                                     
fetch http://dl-cdn.alpinelinux.org/alpine/v3.12/community/aarch64/APKINDEX.tar.gz                                                                
postmarketOS [http://172.16.42.2:8000]
2020-09-01 17:02:31.099145 [http://postmarketos1.brixit.nl/postmarketos/v20.05]                                                                   
v3.12.0-283-g612cd12ab6 [http://dl-cdn.alpinelinux.org/alpine/v3.12/main]                                                                         
v3.12.0-276-gbdd3966958 [http://dl-cdn.alpinelinux.org/alpine/v3.12/community]                                                                    
OK: 12967 distinct packages available
phone:~$ sudo apk upgrade hello-world

pmos-update-kernel

Warning WARNING: Do not use pmos-update-kernel on lk2nd devices, such as MSM8916 devices. lk2nd in boot partition will be replaced and the booting will be broken!

While devices in main and community categories are expected to update the kernel fully automatically, many Android devices currently need to run pmos-update-kernel after a kernel upgrade, to actually write the new kernel to the partition expected by the bootloader (see boot process). You should check the page for your device or it's platform to know if you need this extra step.

Run it manually

Install postmarketos-update-kernel, figure out the kernel flavor (in the example below: postmarketos-qcom-msm8974) and update the kernel:

phone:~$ sudo apk add postmarketos-update-kernel
phone:~$ ls /boot/boot.img-*
/boot/boot.img-postmarketos-qcom-msm8974
phone:~$ sudo pmos-update-kernel postmarketos-qcom-msm8974

Automate with a script

If you're experimenting with mainline kernel and adding new features you might end up wanting to update your kernel and restart your phone very often. On the kernel building end you can use envkernel.sh + pmbootstrap build --envkernel MAINLINE_LINUX_PACKAGE_NAME. That will produce a fresh new kernel package with the changes you made. Then you need to install that package to the phone.

Use this script to automate the steps above (adjust postmarketos-qcom-msm8974!):

#!/bin/sh -ex
# Upgrade all packages (should have your kernel upgrade)
sudo apk update
sudo apk add postmarketos-update-kernel
sudo apk upgrade

# Write kernel to location expected by LK
sudo pmos-update-kernel postmarketos-qcom-msm8974

# Prompt for restart
set +x
echo -n 'reboot [yN]? '
read ans
test "$ans" = 'y' && sudo reboot

See also