net-im/signal-cli 0.9.0_1,1 DragonFly

Command-line and D-Bus interface for Signal and libsignal-service-java

System: DragonFly
Repository: DPorts
Maintainer: [email protected] (as in FreeBSD)
License: GPLv3
Categories: java, net-im
Package size: 18055.8 KiB, 20681.3 KiB installed

Description

signal-cli is a command-line interface for libsignal-service-java. It supports registering, verifying, sending and receiving messages. To be able to link to an existing Signal-Android/signal-cli instance, signal-cli uses a patched libsignal-service-java, because libsignal-service-java does not yet support provisioning as a slave device. For registering you need a phone number where you can receive SMS or incoming calls. signal-cli is primarily intended to be used on servers to notify admins of important events. For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.

In the other systems

System

Port

Version

DragonFly

net-im/signal-cli

0.9.0_1,1

FreeBSD

net-im/signal-cli

0.14.8,1

MidnightBSD

net-im/signal-cli

0.9.0_1,1

HardenedBSD

net-im/signal-cli

0.14.8,1

Install

Binary package:

pkg install signal-cli

From DPorts:

cd /usr/dports/net-im/signal-cli && make install clean

Dependencies

Run dependencies 4

Required by 1

net-im/scli

Configuration

No options to configure.

Service scripts: none

Message after installing

Quick start
===========

1. Generate a QR code to link this signal-cli to the other user device like a
   phone or tablet with a Signal app (this step requires qrencode(1), which is
   an additional utility provided by the graphics/libqrencode port):

       signal-cli link -n DEVICENAME | xargs -n 1 qrencode -t ANSI256

2. Scan the generated QR code with an app.

3. Send a test message to yourself:

       signal-cli -u NUMBER send -m "This is a test" NUMBER

See the signal-cli wiki for more details:
https://github.com/AsamK/signal-cli/wiki

Running a signal-cli daemon (using D-Bus user bus)
==================================================

The DBUS_SESSION_BUS_ADDRESS environment variable should be present for
signal-cli to function properly when run as a daemon (`signal-cli daemon`).

The easiest way is to run the graphical session with dbus-run-session(1), e.g.:

    dbus-run-session -- startx

signal_cli service (using D-Bus system bus)
===========================================

There is an rc(8) script available for signal-cli if it's desired to use
signal-cli in a daemon mode with the D-Bus system bus.

First, configure the service in rc.conf(5):

    sysrc signal_cli_enable="YES"
    sysrc signal_cli_phone_number="+48123456789"

Before starting the service, it is needed to either register a new Signal
account or to link this machine with an existing account. It is possible to
create a linking URL this way:

    service signal_cli runcli link -n DEVICENAME

See the signal-cli wiki for more details:
https://github.com/AsamK/signal-cli/wiki

===>   NOTICE:

The signal-cli port currently does not have a maintainer. As a result, it is
more likely to have unresolved issues, not be up-to-date, or even be removed in
the future. To volunteer to maintain this port, please create an issue at:

https://bugs.freebsd.org/bugzilla

More information about port maintainership is available at:

https://docs.freebsd.org/en/articles/contributing/#ports-contributing