diff --git a/README.md b/README.md index d325823..d1b14d1 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ To access Fermi after starting, simply go to http://localhost:8080/login and eit If there are any issues please report them either here, or to me dirrectly on spacebar ## Adding instances to the dropdown Please see [this](https://github.com/MathMan05/Fermi/blob/main/InstanceInfo.md) for how to add an instance to the dropdown picker +## How to statically host Fermi +[Click here](./howToStaticallyHost.md) ## RoadMap You can view the current roadmap on https://github.com/users/MathMan05/projects/1. ## AI Code diff --git a/howToStaticallyHost.md b/howToStaticallyHost.md new file mode 100644 index 0000000..de93ef6 --- /dev/null +++ b/howToStaticallyHost.md @@ -0,0 +1,14 @@ +### How to statically host Fermi +Fermi due to its service worker, will technically work without any of this, but here's what you need to keep in mind for statically hosting it. +### I will assume the following +* 404.html will be used for 404 responses +* index.html will be used when in that directory +* stuff like `/app` will just use the html file at `/app.html` + +Here's the other thing you need to do: +You need to make some rewrites, not redirects from these addresses: +* `/channels/*` -> `/app.html` +* `/invite/*` -> `invite.html` +* `/template/*` -> `template.html` +Other than these three rewrites, everything else should work as expected! +(the reason why the service worker can fix this is due to it doing the rewrites on the client side)