TheAnachronism/tt-rss-viewer
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Friend install and update docs #56

New issue
Closed
opened 2026-08-03 22:43:05 +00:00 by TheAnachronism · 1 comment
TheAnachronism commented 2026-08-03 22:43:05 +00:00
Owner
Copy link

Part of #41
Blocked by: #52, #54, #55

Question

What is the minimum install/update documentation a friend needs to sideload and stay current on 1.0 beta?

Part of #41 Blocked by: #52, #54, #55 ## Question What is the minimum install/update documentation a friend needs to sideload and stay current on 1.0 beta?
TheAnachronism commented 2026-08-04 19:23:53 +00:00
Author
Owner
Copy link

Resolution

Install / update docs bar for sideload 1.0 beta (criteria only — write later):

Must — docs/install.md

Short how-to for installers / users / sideload testers. Do not use the word “friend” in this prose.

  1. Get the APK — download from this repo’s Forgejo Releases; expect asset stem tt-rss-viewer-…. Stay channel-agnostic in the criteria (exact tag prefix filled after Release channel for beta, or say “the 1.0 beta release”).
  2. Install on Android — allow installs from this source / unknown apps; install the APK; open tt-rss Viewer.
  3. Sign-in / API prerequisite — need a self-hosted tt-rss with API enabled (ENABLE_API_ACCESS), plus base URL, username, and password.
  4. How to update — later APKs from Releases install over the current one when offered; check Releases for updates. No in-app updater (Signing and update trust).
  5. Privacy must-disclose — password + sid stored on-device for silent re-login; network only to the user’s own tt-rss (Privacy surface for friends).
  6. Alpha → beta reinstall note — plain language: if an older alpha build was installed, uninstall may be required before installing beta (different app identity). No certificate/signing jargon (App identity and versioning, Signing and update trust).

README points here per Contributor and user docs bar; do not duplicate the full how-to in README.

Not must for beta

  • Screenshots / per-OEM unknown-apps walkthroughs
  • Troubleshooting encyclopedia
  • Document-band known-issues section (that inventory stays in the polish/readiness bar)
  • Operator keystore / signing-cert prose

Why

Sideload testers need a single short page that gets them from Releases → installed → signed in → updated, with the privacy and one-time reinstall facts already locked — not a full support manual.

## Resolution **Install / update docs bar** for sideload **1.0 beta** (criteria only — write later): ### Must — `docs/install.md` Short how-to for installers / users / sideload testers. **Do not** use the word “friend” in this prose. 1. **Get the APK** — download from this repo’s Forgejo Releases; expect asset stem `tt-rss-viewer-…`. Stay **channel-agnostic** in the criteria (exact tag prefix filled after [Release channel for beta](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/57), or say “the 1.0 beta release”). 2. **Install on Android** — allow installs from this source / unknown apps; install the APK; open **tt-rss Viewer**. 3. **Sign-in / API prerequisite** — need a self-hosted tt-rss with API enabled (`ENABLE_API_ACCESS`), plus base URL, username, and password. 4. **How to update** — later APKs from Releases install over the current one when offered; check Releases for updates. No in-app updater ([Signing and update trust](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/54)). 5. **Privacy must-disclose** — password + `sid` stored on-device for silent re-login; network only to the user’s own tt-rss ([Privacy surface for friends](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/55)). 6. **Alpha → beta reinstall note** — plain language: if an older alpha build was installed, uninstall may be required before installing beta (different app identity). No certificate/signing jargon ([App identity and versioning](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/52), [Signing and update trust](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/54)). README points here per [Contributor and user docs bar](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/51); do not duplicate the full how-to in README. ### Not must for beta - Screenshots / per-OEM unknown-apps walkthroughs - Troubleshooting encyclopedia - Document-band known-issues section (that inventory stays in the polish/readiness bar) - Operator keystore / signing-cert prose ### Why Sideload testers need a single short page that gets them from Releases → installed → signed in → updated, with the privacy and one-time reinstall facts already locked — not a full support manual.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
beta/0.0.4
beta/0.0.3
beta/0.0.2
beta/0.0.1
alpha/0.0.2
Labels
Clear labels   
needs-info
Waiting on reporter for more information

  
needs-triage
Maintainer needs to evaluate this issue

  
ready-for-agent
Fully specified, ready for an AFK agent

  
ready-for-human
Requires human implementation

  
wayfinder:grilling
HITL grilling/decision ticket

  
wayfinder:map
Wayfinder effort map

  
wayfinder:prototype
HITL prototype ticket

  
wayfinder:research
AFK research ticket

  
wayfinder:task
Unblocking manual task ticket

  
wontfix
Will not be actioned

No labels
needs-info
needs-triage
ready-for-agent
ready-for-human
wayfinder:grilling
wayfinder:map
wayfinder:prototype
wayfinder:research
wayfinder:task
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
TheAnachronism
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
TheAnachronism/tt-rss-viewer#56
No description provided.