Skip to content

Commit 880877c

Browse files
committed
README maintenance and note about donations
1 parent 4e87033 commit 880877c

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

README.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# MollySocket Fly.io Service
22

3-
Get Signal push notifications without Google Play Services, and without killing your phone's
4-
battery. A secure, free, low-maintenance solution using [Fly.io](https://fly.io).
3+
Get Signal push notifications without Google Play Services, and without
4+
killing your phone's battery. A secure, free, low-maintenance solution using
5+
[Fly.io](https://fly.io).
56

67
**Table of Contents:**
78

@@ -14,33 +15,49 @@ battery. A secure, free, low-maintenance solution using [Fly.io](https://fly.io)
1415
I'm going to [quote the upstream MollySocket project](https://github.com/mollyim/mollysocket/?tab=readme-ov-file#disclaimer)
1516
because I couldn't say it any better:
1617

17-
> This project is NOT sponsored by or affiliated to Signal Messenger or Signal Foundation.
18+
> This project is NOT sponsored by or affiliated to Signal Messenger or Signal
19+
> Foundation.
1820
>
19-
> The software is produced independently of Signal and carries no guarantee about quality, security
20-
> or anything else. Use at your own risk.
21+
> The software is produced independently of Signal and carries no guarantee about
22+
> quality, security or anything else. Use at your own risk.
2123
2224
## Side Notes
2325

24-
**Free tier:**
26+
**Donations:**
2527

26-
_Never assume a free tier for any service will stay around forever._ However as of May 2024:
28+
You can certainly [buy me a muffin on Ko-fi](https://ko-fi.com/pcrockett) for the little
29+
bit of effort I put into this project, however this project is so trivial to maintain
30+
because it stands on the shoulders of giants. I'd encourage you to first [send donations
31+
to Molly](https://opencollective.com/mollyim#category-CONTRIBUTE) before you think about
32+
sending them to me.
2733

28-
This should be within the limits of the Fly.io free tier. You may see some expensive-looking
29-
"builder" machines in your Fly dashboard, but they are given to you for free. If you do rack up
30-
some bills while using the service, Fly will also not charge you for anything less than $5.
34+
Seriously. It's nice to know that people find this project to be helpful. A simple
35+
"thanks!" is enough to motivate me to keep it running.
36+
37+
**Fly's free tier:**
38+
39+
_Never assume a free tier for any service will stay around forever._ However as of May
40+
2024:
41+
42+
This should be within the limits of the Fly.io free tier. You may see some
43+
expensive-looking "builder" machines in your Fly dashboard, but they are given to you
44+
for free. If you do rack up some bills while using the service, Fly will also not charge
45+
you for anything less than $5.
3146

3247
**This isn't the normal way of doing things:**
3348

3449
The project deviates from the usual pattern that most people set up with Fly.io:
3550

36-
* Fly.io really encourages you to set up your apps with redundancy by default. This configuration
37-
does NOT do that. Push notifications are not a critical service for me and my users, so I can
38-
afford a few seconds of downtime every now and then.
39-
* Because we're using air gap mode, we have no need to provide an actual Internet-facing service. So
40-
the only process that's running in Fly.io is a _worker_ process, and it should be impossible to
41-
actually interact with the MollySocket instance besides via `flyctl ssh console`.
51+
* Fly.io really encourages you to set up your apps with redundancy by default. This
52+
configuration does NOT do that. Push notifications are not a critical service for me
53+
and my users, so I can afford a few seconds of downtime every now and then.
54+
* Because we're using air gap mode, we have no need to provide an actual Internet-facing
55+
service. So the only process that's running in Fly.io is a _worker_ process, and it
56+
should be impossible to actually interact with the MollySocket instance besides via
57+
`flyctl ssh console`.
4258

4359
**The Makefile:**
4460

45-
The [Makefile](Makefile) isn't terribly useful; I just created it to help me remember basic Fly.io
46-
CLI commands. I'm not a frequent Fly.io user by any stretch of the imagination.
61+
The [Makefile](./Makefile) isn't terribly useful; I just created it to help me remember
62+
basic Fly.io CLI commands. I'm not a frequent Fly.io user by any stretch of the
63+
imagination.

0 commit comments

Comments
 (0)