Signald: Difference between revisions

(11 intermediate revisions by 4 users not shown)

Line 1:

[https://signald.org Signald] is a program that ~~enables~~ users to send and receive end-to-end encrypted messages using the Signal protocol. It ~~serves~~ as a bridge between the [https://signal.org Signal messaging app] and other applications or services, allowing developers to integrate secure messaging capabilities into their own projects.

[https://signald.org Signald] was a program that enabled users to send and receive end-to-end encrypted messages using the Signal protocol. The project has been unmaintained for a while now and the "services.signald" option by now only outputs a message to remove it from the configuration. The projects website recommends former users of Signald move towards [[Signald#Troubleshooting|signal-cli]].

It served as a bridge between the [https://signal.org Signal messaging app] and other applications or services, allowing developers to integrate secure messaging capabilities into their own projects.

== Installation ==

Line 15:

Line 17:

=== Registration ===

NOTE: The registration process described here was still [https://gitlab.com/signald/signald/-/issues/372 broken] when the project was discontinued. Please refer to the [[Signald#Troubleshooting|troubleshooting section]] below for a workaround using signal-cli.

Connect and register a phone number of an existing Signal account using following command. It will print a QR code which you can scan on your mobile device. Navigate to "Settings -> Linked devices" on your mobile app.

Line 28:

Line 32:

</syntaxhighlight>

Sometimes you'll have to generate and supply a [https://signald.org/articles/captcha/ captcha verification code] to this command by using the <code>--captcha</code> parameter~~. The registration process described here might be [https://gitlab.com/signald/signald/-/issues/372 currently broken], please refer the troubleshooting section here for a workaround~~.

Sometimes you'll have to generate and supply a [https://signald.org/articles/captcha/ captcha verification code] to this command by using the <code>--captcha</code> parameter.

In the last step, enter the verification number you received via SMS using this command

Line 37:

Line 41:

== Usage ==

=== Configuration ===

Set profile name of account <code>+12025555555</code>

# signaldctl account set-profile -a +12025555555 "my signal user"

</syntaxhighlight>

=== Messaging ===

Send a message to the recipient number <code>+12026666666</code> using the account <code>+12025555555</code>

Line 44:

Line 58:

</syntaxhighlight>

Send message to a group

Send message to a group using the account <code>+12025555555</code>. You'll find the group id by generating a group link of an existing group in the settings section, for example on your mobile phone with the Signal app.

Line 50:

Line 64:

</syntaxhighlight>

[[Category:~~Messaging~~]]

=== Group handling ===

Join a chat group with the account <code>+12025555555</code>

# signaldctl group join -a +12025555555 EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=

</syntaxhighlight>

== Troubleshooting ==

=== Registration fails with "error registering with server" ===

This registration error might be related to an [https://gitlab.com/signald/signald/-/issues/372 unfixed bug] in Signald. It is possible to use the projects successor <code>signal-cli</code> to register and verify a new phone number and use Signald as a secondary "device" by linking it

# nix-shell -p nixos.signal-cli

# Register account with the phone number +12025555555. You'll most likley need to generate a captcha and specify it with a parameter. See registration section above on how to do this.

# signal-cli -a "+12025555555" register --captcha "abcd"

Enter the verification number received via SMS

# signal-cli -a "+12025555555" verify "1234"

Generate the device uri in Signald to link the existing account

# signaldctl account link --output-format json

Use the uri generated above in the following command

# signal-cli -a "+12025555555" addDevice --uri "abcd"

</syntaxhighlight>

Now Signald is able to use the phone number <code>+12025555555</code>, registered with signal-cli, as a secondary device.

== Tips and tricks ==

=== Similar projects ===

[https://github.com/AsamK/signal-cli signal-cli] is the successor of Signald and the project recommended all former users to migrate towards it.

=== Python chat bot ===

The Python module [https://codeberg.org/lazlo/semaphore semaphore] can be used to interact with your Signald account and to create simple chat bots.

[[Category:Applications]]

@@ Line 1: / Line 1: @@
-[https://signald.org Signald] is a program that enables users to send and receive end-to-end encrypted messages using the Signal protocol. It serves as a bridge between the [https://signal.org Signal messaging app] and other applications or services, allowing developers to integrate secure messaging capabilities into their own projects.
+[https://signald.org Signald] was a program that enabled users to send and receive end-to-end encrypted messages using the Signal protocol. The project has been unmaintained for a while now and the "services.signald" option by now only outputs a message to remove it from the configuration. The projects website recommends former users of Signald move towards [[Signald#Troubleshooting|signal-cli]].
+It served as a bridge between the [https://signal.org Signal messaging app] and other applications or services, allowing developers to integrate secure messaging capabilities into their own projects.
 == Installation ==
@@ Line 15: / Line 17: @@
 === Registration ===
+NOTE: The registration process described here was still [https://gitlab.com/signald/signald/-/issues/372 broken] when the project was discontinued. Please refer to the [[Signald#Troubleshooting|troubleshooting section]] below for a workaround using signal-cli.
 Connect and register a phone number of an existing Signal account using following command. It will print a QR code which you can scan on your mobile device. Navigate to "Settings -> Linked devices" on your mobile app.
@@ Line 28: / Line 32: @@
 </syntaxhighlight>
-Sometimes you'll have to generate and supply a [https://signald.org/articles/captcha/ captcha verification code] to this command by using the <code>--captcha</code> parameter. The registration process described here might be [https://gitlab.com/signald/signald/-/issues/372 currently broken], please refer the troubleshooting section here for a workaround.
+Sometimes you'll have to generate and supply a [https://signald.org/articles/captcha/ captcha verification code] to this command by using the <code>--captcha</code> parameter.
 In the last step, enter the verification number you received via SMS using this command
@@ Line 37: / Line 41: @@
 == Usage ==
+=== Configuration ===
+Set profile name of account <code>+12025555555</code>
+<syntaxhighlight lang="console">
+# signaldctl account set-profile -a +12025555555 "my signal user"
+</syntaxhighlight>
+=== Messaging ===
 Send a message to the recipient number <code>+12026666666</code> using the account <code>+12025555555</code>
@@ Line 44: / Line 58: @@
 </syntaxhighlight>
-Send message to a group
+Send message to a group using the account <code>+12025555555</code>. You'll find the group id by generating a group link of an existing group in the settings section, for example on your mobile phone with the Signal app.
 <syntaxhighlight lang="console">
@@ Line 50: / Line 64: @@
 </syntaxhighlight>
-[[Category:Messaging]]
+=== Group handling ===
+Join a chat group with the account <code>+12025555555</code>
+<syntaxhighlight lang="console">
+# signaldctl group join -a +12025555555 EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=
+</syntaxhighlight>
+== Troubleshooting ==
+=== Registration fails with "error registering with server" ===
+This registration error might be related to an [https://gitlab.com/signald/signald/-/issues/372 unfixed bug] in Signald. It is possible to use the projects successor <code>signal-cli</code> to register and verify a new phone number and use Signald as a secondary "device" by linking it
+<syntaxhighlight lang="console">
+# nix-shell -p nixos.signal-cli
+# Register account with the phone number +12025555555. You'll most likley need to generate a captcha and specify it with a parameter. See registration section above on how to do this.
+# signal-cli -a "+12025555555" register --captcha "abcd"
+Enter the verification number received via SMS
+# signal-cli -a "+12025555555" verify "1234"
+Generate the device uri in Signald to link the existing account
+# signaldctl account link --output-format json
+Use the uri generated above in the following command
+# signal-cli -a "+12025555555" addDevice --uri "abcd"
+</syntaxhighlight>
+Now Signald is able to use the phone number <code>+12025555555</code>, registered with signal-cli, as a secondary device.
+== Tips and tricks ==
+=== Similar projects ===
+[https://github.com/AsamK/signal-cli signal-cli] is the successor of Signald and the project recommended all former users to migrate towards it.
+=== Python chat bot ===
+The Python module [https://codeberg.org/lazlo/semaphore semaphore] can be used to interact with your Signald account and to create simple chat bots.
+[[Category:Applications]]