Skip to content

Commit 33fc8ac

Browse files
committed
docs(readme): finally update le README after months
1 parent c912c8a commit 33fc8ac

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
1-
# `proxyparty.recaptime.dev` = Caddy in Docker + GCP Compute Engine VM
1+
# `proxyparty.recaptime.dev` = Caddy in Docker for redirects and stuff
22

33
It's like [`proxyparty.hackclub.com`](https://github.com/hackclub/proxyparty)
4-
but using Caddy as our implementation backend, hosted on a `e2-micro` Compute
5-
Engine VM and on Railway as a Docker container.
4+
but using Caddy as our implementation backend, hosted on a relatively small
5+
Azure VM in Central India (previously on GCP and AWS).
66

77
Currently this service is provided on limited support basis and things may
8-
break. [Consider sponsoring Andrei Jiroh](https://github.com/sponsors/ajhalili2006)
9-
or share your spare compute credits (or donate directly) on
10-
[his Railway profile](https://railway.app/u/ajhalili2006) if you like to
11-
keep this maintained and support his open-source work.
8+
break. Consider funding our open-source work to keep this running at
9+
<https://recaptime.dev/donate>.
1210

1311
## Using the service
1412

15-
TBD
13+
### Parking pages and redirects
14+
15+
If you want to show a parking page for your site while working onto it or redirect to something else:
16+
17+
* [File a GitHub issue][new-issue] with the the destination URL field either:
18+
* being `Not Applicable` and ticking **Show a parking page instead of redirecting**
19+
* or for redirects, fill that in
20+
* Add additional details throughout the form and submit (e.g. additional redirects, etc.)
21+
* Once fully onboarded on our system (through the [Proxyparty Internals API](https://api.proxyparty.recaptime.dev/docs) for Caddy's On-demand TLS feature), add a CNAME record pointing to `proxyparty.recaptime.dev` on your side.
22+
* You're good to go! Caddy will handle the the TLS renewal for you behind the scenes while we manage the infrastructure for you.
23+
24+
[new-issue]: https://github.com/recaptime-dev/proxyparty-caddy/issues/new?template=add-domain.yml
1625

1726
## Self-hosting
1827

0 commit comments

Comments
 (0)