Skip to content

Commit 22d1b18

Browse files
committed
Add tweak screenshots to README and Getting Started guide
- README hero: the private-message and post-reply push notifications at the top, showing the end result of running this backend up front. - Guide: Notification Backend settings + the registration confirmation (step 6), and example pushes on the lock screen (step 7). Screenshots are from the upstream tweak PR Apollo-Reborn/Apollo-Reborn#229, downscaled to ~850-900px wide and re-encoded to JPEG (q85) so the four images total ~1.5 MB instead of the original ~20 MB.
1 parent 52b9b49 commit 22d1b18

6 files changed

Lines changed: 38 additions & 0 deletions

File tree

GETTING_STARTED.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,11 @@ On your iPhone, in Apollo (with the tweak installed):
331331
3. Tap **Test Connection**. This hits `GET /v1/health` on your backend — a success here means the
332332
app can reach it.
333333

334+
<p align="center">
335+
<img src="images/IMG_4296.jpg" width="300"
336+
alt="Apollo Settings → Custom API → Notification Backend, with the Backend URL and Registration Token fields and a Test Connection button">
337+
</p>
338+
334339
While you're here, double-check the **main Custom API screen** has your **Reddit API Key**,
335340
**Redirect URI**, and **User Agent** filled in for *this* bundle ID (you needed these to get Reddit
336341
browsing working at all). The notification backend reuses them.
@@ -341,6 +346,14 @@ Finally, **turn notifications on**:
341346
- Inside Apollo, enable inbox notifications for your account (and add any subreddit/user **watchers**
342347
you want).
343348

349+
Once registration succeeds, the backend sends a **"hello, is this thing on?"** confirmation — a quick
350+
sign the whole chain is wired up:
351+
352+
<p align="center">
353+
<img src="images/IMG_4293.jpg" width="300"
354+
alt="Apollo's in-app notifications settings showing the backend's 'hello, is this thing on?' confirmation after a successful registration">
355+
</p>
356+
344357
---
345358

346359
## 7. Verify end-to-end (a real push)
@@ -385,6 +398,16 @@ can swap in for `post_reply`:
385398
comment_reply private_message username_mention subreddit_watcher trending_post
386399
```
387400

401+
Here's what a delivered push looks like on the lock screen — a private message and a post reply:
402+
403+
<p align="center">
404+
<img src="images/IMG_4294.jpg" width="270"
405+
alt="Private message push notification on the iOS lock screen">
406+
&nbsp;
407+
<img src="images/IMG_4295.jpg" width="270"
408+
alt="Post reply push notification on the iOS lock screen">
409+
</p>
410+
388411
### 7c. The first-message "warmup" gotcha
389412

390413
The **first real inbox message after registration won't notify you.** On its first poll the worker

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
A self-hostable fork of [`christianselig/apollo-backend`](https://github.com/christianselig/apollo-backend), the archived Go service that powered push notifications, inbox checks, and subreddit/user watchers for the original [Apollo for Reddit](https://apolloapp.io/) iOS app.
44

5+
<p align="center">
6+
<img src="images/IMG_4294.jpg" width="270"
7+
alt="Private message push notification from a self-hosted Apollo backend on the iOS lock screen">
8+
&nbsp;
9+
<img src="images/IMG_4295.jpg" width="270"
10+
alt="Post reply push notification from a self-hosted Apollo backend on the iOS lock screen">
11+
</p>
12+
13+
<p align="center"><em>Reddit push notifications, back on a sideloaded Apollo — delivered entirely by your own server.</em></p>
14+
515
This fork is meant to be run together with **[Apollo-Reborn/Apollo-Reborn](https://github.com/Apollo-Reborn/Apollo-Reborn)** — the iOS tweak that lets sideloaded Apollo builds use the user's own Reddit OAuth credentials. The tweak's **Settings > Custom API > Notification Backend** URL field points at an instance of this fork; with that wired up, push notifications and watchers come back to life for sideloads that have a real APNs entitlement.
616

717
Single-tenant by design: one deployment serves one sideloaded Apollo build (one bundle ID, one Apple Developer team), and can be shared with a small group of friends running the same build.
@@ -104,6 +114,11 @@ In the tweak (Apollo on-device): **Settings > Custom API > Notification Backend*
104114

105115
Tap **Test Connection** to verify the tweak can reach `GET /v1/health`.
106116

117+
<p align="center">
118+
<img src="images/IMG_4296.jpg" width="300"
119+
alt="Apollo Settings > Custom API > Notification Backend, showing the Backend URL and Registration Token fields and the Test Connection button">
120+
</p>
121+
107122
Make sure the **Reddit API Key**, **Redirect URI**, and **User Agent** in the tweak's main Custom API screen are filled in for the bundle ID you signed with — Reddit's API rules want a UA shaped like `ios:com.you.Leto:v1.0 (by /u/yourname)`. The tweak attempts to inject these into registration bodies; if injection fails, the backend falls back to the matching `REDDIT_*` env vars (see above). Either path works.
108123

109124
Installed-app Reddit credentials are accepted — just leave the **Reddit API Secret** field blank in the tweak.

images/IMG_4293.jpg

190 KB
Loading

images/IMG_4294.jpg

519 KB
Loading

images/IMG_4295.jpg

521 KB
Loading

images/IMG_4296.jpg

218 KB
Loading

0 commit comments

Comments
 (0)