Am 19.03.25 um 13:25 schrieb Stuart Henderson:
On 2025/03/19 11:18, Stuart Henderson wrote:
Thanks - that's just the sort of thing I had in mind. I have some small
nitpicky format tweaks for README but it would be simpler to do that by
sending a small diff after import.

Any OKs, or would anyone like to import with ok sthen?

Now imported.

Here are some readme tweaks;

- in other pkg-readmes we don't normally add spaces to separate
filenames/URLs from punctuation

- reword to suggest that other reverse proxies are ok too

- avoid "For configuring .. you need to configure"

- reword to avoid "you can set in / add to ${SYSCONFDIR}/mollysocket.conf"
which makes me think that "set in /" refers to the root directory

ok?

Index: Makefile
===================================================================
RCS file: /cvs/ports/net/mollysocket/Makefile,v
diff -u -p -r1.1.1.1 Makefile
--- Makefile    19 Mar 2025 11:29:34 -0000      1.1.1.1
+++ Makefile    19 Mar 2025 12:19:39 -0000
@@ -6,6 +6,7 @@ COMMENT =               get Signal notifications via
  GH_ACCOUNT =          mollyim
  GH_PROJECT =          mollysocket
  GH_TAGNAME =          1.6.0
+REVISION =             0

  CATEGORIES =          net

Index: pkg/README
===================================================================
RCS file: /cvs/ports/net/mollysocket/pkg/README,v
diff -u -p -r1.1.1.1 README
--- pkg/README  19 Mar 2025 11:29:34 -0000      1.1.1.1
+++ pkg/README  19 Mar 2025 12:19:39 -0000
@@ -12,10 +12,10 @@ of a multi-program setup, some of which
  Required software
  -----------------

-For de-googling your Signal experience, you will need:
+For de-googling your Signal experience, as well as mollysocket, you will need:

  - Molly, a fork of Signal, installed from one of the official sources:
-  https://molly.im/get.html .
+  https://molly.im/get.html
  - An UnifiedPush client app on the same android device. See https://ntfy.sh 
for
    reference. This will default to using the public ntfy.sh server for
    notifications. If you'd like to self-host that as well, net/ntfy is 
available
@@ -24,24 +24,24 @@ For de-googling your Signal experience,
    to be able to communicate with mollysocket. relayd can be used for this.
    Even if optional, this is recommended. Otherwise, you'd need to setup
    mollysocket in 'airgapped' mode. Refer to upstream documentation for this.
-- mollysocket on the same host as the (optional) reverse proxy.

  Finish mollysocket install
  ==========================

  Before running mollysocket for the first time, you need to generate a VAPID
-key and append it to ${SYSCONFDIR}/mollysocket.conf . To do this, you may run:
+key and append it to ${SYSCONFDIR}/mollysocket.conf. To do this, you may run:

  # sed -i "s|changeme|$(mollysocket vapid gen)|" ${SYSCONFDIR}/mollysocket.conf

  Since ${SYSCONFDIR}/mollysocket.conf now contains a secret, take care that
  permissions on that file stay restrictive.

-relayd in front of mollysocket
-==============================
+Reverse proxy in front of mollysocket
+=====================================

-By default, mollysocket listens on port 8020 for http connections. This
-snippet should get you started with relayd:
+By default, mollysocket listens to port 8020 on localhost for http
+connections and expects to have an external reverse proxy adding https.
+If using relayd, this snippet should get you started:

      table <mollysocket> { 127.0.0.1 }

@@ -59,16 +59,19 @@ snippet should get you started with rela
        ...
      }

+Other reverse proxies can be used (nginx is common).
+
  Custom UnifiedPush endpoint
  ===========================

-For configuring a custom, possibly self-hosted endpoint, you need to configure
-allowed_endpoints in ${SYSCONFDIR}/mollysocket.conf .
+The default option is to use the public endpoint run at https://ntfy.sh/.
+Others (public or otherwise) can be used; set "allowed_endpoints" in
+${SYSCONFDIR}/mollysocket.conf.

  Post-setup steps
  ================

  After configuring mollysocket on your box, you need to setup the UnifiedPush
-notification backend in the Molly app. This will show you a device ID which
-you can set in / add to ${SYSCONFDIR}/mollysocket.conf as allowed_uuids ,
-preventing any other Molly user from using your mollysocket instance.
+notification backend in the Molly app. This will show a device ID which you
+can optionally set in "allowed_uuids" in ${SYSCONFDIR}/mollysocket.conf, 
preventing
+any other Molly user from using your mollysocket instance.

ok

Reply via email to