From dccd746dd33c33352fb3c2aaa9bfb1532a524d87 Mon Sep 17 00:00:00 2001
From: Joshua Goins <josh@redstrate.com>
Date: Sat, 11 May 2024 13:02:24 -0400
Subject: [PATCH] Add explanation on how to actually use this

---
 Caddyfile | 23 +++++++++++++++++++++++
 README.md | 31 +++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 Caddyfile

diff --git a/Caddyfile b/Caddyfile
new file mode 100644
index 0000000..38d22a2
--- /dev/null
+++ b/Caddyfile
@@ -0,0 +1,23 @@
+{
+  auto_https off
+}
+
+admin.ffxiv.local:80 {
+    reverse_proxy :5800
+}
+
+frontier.ffxiv.local:80 {
+    reverse_proxy :5857
+}
+
+patch-bootver.square.local:80 {
+    reverse_proxy :6900
+}
+
+patch-gamever.square.local:80 {
+    reverse_proxy :6900
+}
+
+ffxiv-login.ffxiv.local:80 {
+    reverse_proxy :6700
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index f92a29f..911622b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 A substitute for a few official servers such as “ffxiv.com” and “square-enix.com”. It’s still early in development, but can already emulate the basic login flow.
 
+**Notice:** This is not allow you to download game files you legally do not have access to, or circumvent other copyright protections enacted by Square Enix.
+
 ## Components
 
 * Admin
@@ -17,6 +19,35 @@ A substitute for a few official servers such as “ffxiv.com” and “square-en
 
 Install [Rust](https://rust-lang.org) and then use the `run.sh` helper script in the repository. You can of course run each server individually.  
 
+### Testing via launcher
+
+Testing on a real launcher is not yet supported, the easiest way is through [Astra](https://github.com/redstrate/Astra) which allows you to plug in your own domains. Because of how the domains are set up, you can't simply plug them in though.
+
+You will need some kind of reverse proxy because simply editing the `hosts` file will not work. Each server is behind a subdomain (like `frontier.square-enix.com`) and some services span multiple subdomains (such as `patch-bootver.square-enix.com` and `patch-gamever.square-enix.com`.) We will walk through using [Caddy](https://caddyserver.com/) for this purpose, but any reverse proxy will do.
+
+First you need to edit your `hosts` file. Assuming you're using the default ports for each server, add the following:
+
+```
+127.0.0.1 admin.ffxiv.local
+127.0.0.1 frontier.ffxiv.local
+127.0.0.1 patch-bootver.square.local
+127.0.0.1 patch-gamever.square.local
+127.0.0.1 ffxiv-login.ffxiv.local
+```
+
+Then run Caddy from the repository's `Caddyfile`. You may need to run it as root because it binds to port 80:
+
+```
+sudo caddy run
+```
+
+And then in Astra, plug these domains like so into Developer Settings:
+
+* `square.local` into the "SE Login Server"
+* `ffxiv.local` into "SE Main Server"
+
+Make sure to set the "preferred protocol" to "HTTP" as well because HTTPS will not work without more setup.
+
 ## License
 
 This project is licensed under the [GNU Affero General Public License 3](LICENSE). Some code or assets may be licensed differently.