summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Busby <contact@benbusby.com>2022-01-27 11:57:41 -0700
committerGitHub <noreply@github.com>2022-01-27 11:57:41 -0700
commit932f3bbcab9be82aafb487d7890fde83b2210a7b (patch)
tree4261df31d3964475057a6139908ce96ad87592b5 /README.md
parent724a995fd9263194b255b82c68a48b5b6e735e30 (diff)
downloadfarside-932f3bbcab9be82aafb487d7890fde83b2210a7b.tar.gz
Preserve redirect with `/_/` path prefix (#13)
This adds a straightforward way of preserving Farside's redirecting behavior in the user's browser history. That way if an instance becomes unavailable between the 5 min scans, the user can opt to navigate back one page and be taken to a new instance. This is accomplished using a single line of JS, and could potentially work as the default behavior of Farside (with the current default behavior requiring a path prefix instead). This should be revisited down the road when more people are using this service.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2c0bd9f..8ecd3d2 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,13 @@ Farside's routing is very minimal, with only the following routes:
URL>/r/popular`
- Note that a path is not required. `/libreddit` for example will still
redirect the user to a working libreddit instance
+- `/_/:service/*glob`
+ - Achieves the same redirect as the main `/:service/*glob` endpoint, but
+ preserves a short landing page in the browser's history to allow quickly
+ jumping between instances by navigating back.
+ - Ex: `/_/nitter` -> nitter instance A -> (navigate back one page) -> nitter
+ instance B -> ...
+ - *Note: Uses Javascript to preserve the page in history*
When a service is requested with the `/:service/...` endpoint, Farside requests
the list of working instances from Redis and returns a random one from the list