finxol.io
1# PDS Home
2
3Very simple single-file PDS home page.
4
5## Why?
6
7By default, the PDS home page isn't very nice, especially on mobile.
8It's fine as a default, but we can do better.
9
10The approach here is to make it into a single glorious HTML file to avoid overriding too many routes on the PDS,
11and make deployment as simple as possible.
12
13There's still a build step involved because there's some dependencies involved (`atcute`),
14and working with types and CSS/JS in separate files is so much nicer.
15
16## How to use
17
18Before you deploy, you may want to fork this repository to customise the welcome message and/or PDS owner listed.
19
20- Install dependencies with `pnpm i`
21
22- Build the file with `pnpm run build`
23
24- Upload the `dist/index.html` file to static hosting.
25
26The most straighforward solution is to host it on the same server as your PDS.
27
28You can simply add this directive to your Caddyfile:
29
30```Caddyfile
31@home path /
32handle @home {
33 root /<the directory where the file is>
34 file_server
35}
36```
37
38You will now see a pretty little home page for your PDS!