Documenting singularity role

roles/Singularity/README.md

@@ -0,0 +1,27 @@
+Singularity is our server-side RSS reader.
+
+# Etymology
+
+Singularity is named after a more scientific name for a "black hole". Similar to this event, Singularity pulls many disparate news sources into a single feed & location. User can then use client apps or a web browser to view this single source of truth.
+
+# Relevant Files and Software
+
+Prior to pushing this role, the admin will want to use `files/create-db.sh` to seed the initial database & schema. Afterwards, deploy this role to the host and front it with a [WebServer](../WebServer).
+
+## Backups
+
+[AniNIX/Aether](/AniNIX/Aether) will back up this system -- sample backup and recovery testing is in `files/test-backup.bash`. It's important to test these, as users won't want to find their feeds over again.
+
+# Available Clients
+
+There is an Android application on [the Play store](https://play.google.com/store/apps/details?id=org.ttrssreader).
+
+# Equivalents or Competition
+
+Android has a native Google Discover mode in the home screen on devices -- Windows also has news in the taskbar.
+
+CLI readers like [Newsraft](https://wiki.archlinux.org/title/Newsraft) or cloud readers like [Feedly](https://feedly.com) are also available. A number of Android apps can serve this function.
+
+# Additional Reference
+
+See [RFC 4287](https://www.rfc-editor.org/rfc/rfc4287) and [5023](https://www.rfc-editor.org/rfc/rfc5023) for details on the Atom format.