Difference between revisions of "PinePhone MMS with Matrix"

From PINE64
Jump to navigation Jump to search
m (Update Mobian Wiki link)
(Fixes)
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
This method works with a local-to-the-pinephone matrix server but you could instead use a public one on the internet. Free accounts on matrix.org should work fine for example. Sleep may need to be disabled for non-local servers or the bridge can get stuck.
This method works with a local-to-the-pinephone matrix server but you could instead use a public one on the internet. Free accounts on matrix.org should work fine for example. Sleep may need to be disabled for non-local servers or the bridge can get stuck.


=Install packages=
== Install packages ==
==Arch==
=== Arch ===
Start with a nice and up-to-date Danctnix' Arch ARM PinePhone installation, mine is from April 20 2021. SSH into the PinePhone and then run this to install all the needed packages
Start with a nice and up-to-date Danctnix' Arch ARM PinePhone installation, mine is from April 20 2021. SSH into the PinePhone and then run this to install all the needed packages


Line 17: Line 17:
Start the service
Start the service


<pre>
sudo systemctl enable synapse
sudo systemctl enable synapse
sudo systemctl start synapse
sudo systemctl start synapse
</pre>


==Mobian==
=== Mobian ===


Flash a fresh mobian nightly (Tested September 28 2021) and install the following:
Flash a fresh mobian nightly (Tested September 28 2021) and install the following:


<pre>sudo apt install matrix-synapse fractal mmsd-tng python3-matrix-nio python3-vobject python3-aiofiles git</pre>
<code>sudo apt install matrix-synapse fractal mmsd-tng python3-matrix-nio python3-vobject python3-aiofiles git</code>


=Set up Matrix Synapse on localhost=
== Set up Matrix Synapse on localhost ==


Skip this if you will be using a remote homeserver. Make a new config with the server name set to local host.  
Skip this if you will be using a remote homeserver. Make a new config with the server name set to local host.  


==Arch==
=== Arch ===


<pre>
cd /etc/synapse/
cd /etc/synapse/
sudo python -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no
sudo python -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no
</pre>


<pre>
sudo vi /usr/lib/systemd/user/matrix-synapse.service
sudo vi /usr/lib/systemd/user/matrix-synapse.service
</pre>


<pre>
<pre>
Line 59: Line 53:


Start the service
Start the service
<pre>
systemctl enable matrix-synapse --user
systemctl start matrix-synapse --user


</pre>
systemctl enable matrix-synapse --user
systemctl start matrix-synapse --user
 
=== Mobian ===


==mobian==
cd /etc/matrix-synapse/
<pre>
sudo rm homeserver.*
cd /etc/matrix-synapse/
sudo python3 -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no
sudo rm homeserver.*
sudo service matrix-synapse start
sudo python3 -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no
sudo service matrix-synapse start
</pre>


== Add new matrix users ==
=== Add new matrix users ===
in /etc/synapse/ (arch) or /etc/matrix-synapse/ (mobian)
in /etc/synapse/ (arch) or /etc/matrix-synapse/ (mobian)


<pre>
register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be pp
register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be pp
register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be mm
register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be mm
</pre>


Open fractal and log into the homeserver at http://localhost:8008 with username pp and password pp
Open fractal and log into the homeserver at http://localhost:8008 with username pp and password pp


=Set up MMSD=
== Set up MMSD ==
 
=== From git ===
 
Note: historical, no longer needed, mmsdtng commonly packaged


==from git (historical, no longer needed, mmsdtng commonly packaged)==
Grab the git repository and install it:
Grab the git repository and install it:


Line 121: Line 113:
</pre>
</pre>


==Settings for T-Mobile==
=== Settings for T-Mobile ===
This config works for me
This config works for me


Line 133: Line 125:
</pre>
</pre>


==Restart MMSD ModemManager service==
=== Restart MMSD ModemManager service ===


<pre>
systemctl restart mmsdtng
systemctl restart mmsdtng
</pre>


=Install MMS bridge=
== Install MMS bridge ==
Grab it from git and put things in places
Grab it from git and put things in places


Line 152: Line 142:
</pre>
</pre>


==Configure MMS bridge==
=== Configure MMS bridge ===
This will mostly take care of editing the config for you if you are running a local matrix server.
This will mostly take care of editing the config for you if you are running a local matrix server.


Line 173: Line 163:
Now we need to run it once to process the config file and remove secrets (It will say it has done this and exit on first run)
Now we need to run it once to process the config file and remove secrets (It will say it has done this and exit on first run)


<pre>
/usr/local/bin/mmmpuppet.py
/usr/local/bin/mmmpuppet.py
</pre>


check it out now
check it out now


<pre>
cat $HOME/.config/mmm/conf.json
cat $HOME/.config/mmm/conf.json
</pre>


If it doesn't change the file to remove all the linebreaks then it didn't like it. Figure out why by looking at the log file.
If it doesn't change the file to remove all the linebreaks then it didn't like it. Figure out why by looking at the log file.


<pre>
cat ~/.config/mmm/mmmpuppet.log
cat ~/.config/mmm/mmmpuppet.log
</pre>


Go fix whatever went wrong. Which should be nothing. You should have seen a message like this as output before it returns you to a prompt:
Go fix whatever went wrong. Which should be nothing. You should have seen a message like this as output before it returns you to a prompt:


<pre>
Login successful. Config updated with token. Run again to start bridge.
Login successful. Config updated with token. Run again to start bridge.
</pre>


==Set up MMS bridge service==
=== Set up MMS bridge service ===


Make systemd unit
Make systemd unit
Line 223: Line 205:
</pre>
</pre>


done? see if services are running:
See if services are running:


<pre>
ps aux | grep mm
ps aux | grep mm
</pre>


should show something like this even after reboot
It should show something like this even after reboot


<pre>
<pre>
Line 236: Line 216:
</pre>
</pre>


=Remove chatty=
== Remove Chatty ==
for arch do pacman stuff to remove chatty
 
For Arch use Pacman to remove Chatty.
 
Mobian:


mobian
apt remove chatty
<pre>
apt remove chatty
</pre>


=Don't forget to enable data=
== Don't forget to enable data ==


You can get sms but not mms with mobile data off
You can get SMS but not MMS with mobile data off


=Launch fractal=
== Launch fractal ==


Log in with this homeserver
Log in with this homeserver


<pre>http://localhost:8008</pre>
http://localhost:8008


username <pre>pp</pre> and password <pre>pp</pre>
username <code>pp</code> and password <code>pp</code>


Logins are not saved. You need to add a new item named login to the gnome keyring manually to fix it. See: https://wiki.mobian.org/doku.php?id=fractal
Logins are not saved. You need to add a new item named login to the gnome keyring manually to fix it. See: https://wiki.mobian.org/doku.php?id=fractal
Line 260: Line 240:
Basically apt install seahorse, open "passwords and keys" in the app drawer, click new (plus), select password keyring, and name it "login" (all lower no quotes). Then autologin will work as it should.
Basically apt install seahorse, open "passwords and keys" in the app drawer, click new (plus), select password keyring, and name it "login" (all lower no quotes). Then autologin will work as it should.


=Done=
== Done ==
At this point if you get a message a new room should be created by the bridge bot which you will be invited to. You can start a new conversation by creating a new room, setting the topic with phone numbers of participants, and then inviting the mm user. See the mmmpuppet readme for examples.
At this point if you get a message a new room should be created by the bridge bot which you will be invited to. You can start a new conversation by creating a new room, setting the topic with phone numbers of participants, and then inviting the mm user. See the mmmpuppet readme for examples.


=Other clients=
== Other clients ==
 
'''quaternion''' also seems to work but has clunky UI issues. Might work better with scaling
 


quaternion also seems to work but has clunky UI issues. Might work better with scaling
[[Category:PinePhone]]

Latest revision as of 01:04, 16 March 2023

Screenshot of fractal displaying an MMS conversation

The one known way to get MMS fully (meaning pictures and group messages) working is by relaying all SMS and MMS to a matrix server and using a matrix client to interact with them. https://gitlab.com/untidylamp/mmmpuppet is the bridge used here

Outgoing messages over the max size are sent as a link. The link will not resolve if matrix is hosted on the PinePhone itself, so resize your images. An easy way might be to take a screenshot of your image viewer and send that image instead.

This method works with a local-to-the-pinephone matrix server but you could instead use a public one on the internet. Free accounts on matrix.org should work fine for example. Sleep may need to be disabled for non-local servers or the bridge can get stuck.

Install packages

Arch

Start with a nice and up-to-date Danctnix' Arch ARM PinePhone installation, mine is from April 20 2021. SSH into the PinePhone and then run this to install all the needed packages 

sudo pacman -Sy matrix-synapse fractal python-matrix_client python-gobject git meson ninja base-devel python-matrix-nio python-dbus

Start the service 

sudo systemctl enable synapse
sudo systemctl start synapse

Mobian

Flash a fresh mobian nightly (Tested September 28 2021) and install the following:

sudo apt install matrix-synapse fractal mmsd-tng python3-matrix-nio python3-vobject python3-aiofiles git

Set up Matrix Synapse on localhost

Skip this if you will be using a remote homeserver. Make a new config with the server name set to local host.

Arch

cd /etc/synapse/
sudo python -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no

sudo vi /usr/lib/systemd/user/matrix-synapse.service

[Unit]
Description=Multimedia Messaging Service Daemon
After=ModemManager.service

[Service]
ExecStart= python3 -m synapse.app.homeserver --config-path=/etc/matrix/homeserver.yaml

Restart=on-failure
RestartSec=10s

[Install]
WantedBy=default.target

Start the service 

systemctl enable matrix-synapse --user
systemctl start matrix-synapse --user

Mobian

cd /etc/matrix-synapse/
sudo rm homeserver.*
sudo python3 -m synapse.app.homeserver --server-name localhost --config-path homeserver.yaml --generate-config --report-stats=no
sudo service matrix-synapse start

Add new matrix users

in /etc/synapse/ (arch) or /etc/matrix-synapse/ (mobian) 

register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be pp
register_new_matrix_user -c homeserver.yaml http://localhost:8008 # New user name and pw will both be mm

Open fractal and log into the homeserver at http://localhost:8008 with username pp and password pp

Set up MMSD

From git

Note: historical, no longer needed, mmsdtng commonly packaged

Grab the git repository and install it: 

cd ~
git clone https://source.puri.sm/kop316/mmsd.git
cd mmsd
meson _build
meson compile -C _build
meson test -C _build
sudo meson install -C _build

sudo vi /usr/lib/systemd/user/mmsd-mm.service

[Unit]
Description=Multimedia Messaging Service Daemon
After=ModemManager.service

[Service]
ExecStart=/usr/local/bin/mmsd -n -d

Restart=on-failure
RestartSec=10s

[Install]
WantedBy=default.target

sudo chmod 644 /usr/lib/systemd/user/mmsd-mm.service
systemctl enable mmsd-mm.service --user
systemctl start mmsd-mm --user

Settings for T-Mobile

This config works for me

After starting mmsdtng the first time it should generate a config. Edit the following 3 options: 

vi ~/.mms/modemmanager/ModemManagerSettings

CarrierMMSC=http://mms.msg.eng.t-mobile.com/mms/wapenc
MMS_APN=fast.t-mobile.com
AutoProcessSMSWAP=true

Restart MMSD ModemManager service

systemctl restart mmsdtng

Install MMS bridge

Grab it from git and put things in places 

cd ~
git clone https://gitlab.com/untidylamp/mmmpuppet.git
cd mmmpuppet
chmod +x mmmpuppet.py
sudo cp mmm*.py /usr/local/bin/
mkdir -p $HOME/.config/mmm/
cp conf.json.sample $HOME/.config/mmm/conf.json

Configure MMS bridge

This will mostly take care of editing the config for you if you are running a local matrix server. 

sed -i 's^"https://matrix-client.matrix.org"^"http://localhost:8008"^' $HOME/.config/mmm/conf.json
sed -i 's^"@bot_account:matrix.org"^"@mm:localhost"^' $HOME/.config/mmm/conf.json
sed -i 's^"Change_me"^"mm"^' $HOME/.config/mmm/conf.json
sed -i 's^"@your_accounts:matrix.org"^"@pp:localhost"^' $HOME/.config/mmm/conf.json

You actually have to fill these two out yourself. I put "US" and my +1 and rest of 10 digit number. 

vi  $HOME/.config/mmm/conf.json

"cell_number":      "+15554441234",
"cell_country":     "CA",

Now we need to run it once to process the config file and remove secrets (It will say it has done this and exit on first run) 

/usr/local/bin/mmmpuppet.py

check it out now 

cat $HOME/.config/mmm/conf.json

If it doesn't change the file to remove all the linebreaks then it didn't like it. Figure out why by looking at the log file. 

cat ~/.config/mmm/mmmpuppet.log

Go fix whatever went wrong. Which should be nothing. You should have seen a message like this as output before it returns you to a prompt: 

Login successful. Config updated with token. Run again to start bridge.

Set up MMS bridge service

Make systemd unit 

sudo vi /usr/lib/systemd/user/mmmpuppet.service

[Unit]
Description=Starts mmmpuppet interface
After=mmsd-mm.service

[Service]
ExecStart=/usr/bin/python3 /usr/local/bin/mmmpuppet.py
Restart=on-failure
RestartSec=10s

[Install]
WantedBy=default.target

and start it 

sudo chmod 644 /usr/lib/systemd/user/mmmpuppet.service
systemctl enable mmmpuppet.service --user
systemctl start mmmpuppet.service --user

See if services are running: 

ps aux | grep mm

It should show something like this even after reboot 

alarm       6374  0.0  0.3 235364  7752 ?        Ssl  22:44   0:00 /usr/local/bin/mmsd -n -d
alarm       6825  9.8  2.7 224976 54188 ?        Ssl  22:52   0:05 /usr/bin/python3 /usr/local/bin/mmmpuppet.py

Remove Chatty

For Arch use Pacman to remove Chatty.

Mobian: 

apt remove chatty

Don't forget to enable data

You can get SMS but not MMS with mobile data off

Launch fractal

Log in with this homeserver 

http://localhost:8008

username pp and password pp

Logins are not saved. You need to add a new item named login to the gnome keyring manually to fix it. See: https://wiki.mobian.org/doku.php?id=fractal

Basically apt install seahorse, open "passwords and keys" in the app drawer, click new (plus), select password keyring, and name it "login" (all lower no quotes). Then autologin will work as it should.

Done

At this point if you get a message a new room should be created by the bridge bot which you will be invited to. You can start a new conversation by creating a new room, setting the topic with phone numbers of participants, and then inviting the mm user. See the mmmpuppet readme for examples.

Other clients

quaternion also seems to work but has clunky UI issues. Might work better with scaling

Retrieved from "https://wiki.pine64.org/index.php?title=PinePhone_MMS_with_Matrix&oldid=18739"