aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Joe Banks <[email protected]>2024-08-16 21:11:19 +0100
committerGravatar Joe Banks <[email protected]>2024-08-16 21:11:19 +0100
commit30902e4d179369371ad372efb11a2c24e80872e0 (patch)
tree45822dafc4316f2d1a8d47ea82653832f8b3d040
parentUpdate root of pydis.wtf to alias to lovelace instead of holding IPv4 (diff)
Add documentation on using public folders
-rw-r--r--docs/docs/onboarding/public_folders.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/docs/onboarding/public_folders.md b/docs/docs/onboarding/public_folders.md
new file mode 100644
index 0000000..566e22d
--- /dev/null
+++ b/docs/docs/onboarding/public_folders.md
@@ -0,0 +1,21 @@
+---
+description: Documentation on using the ~/public folders on lovelace
+---
+# Web-accessible `public` folders
+
+DevOps team members are automatically provided access to `lovelace`, one of our
+Debian machines. Access is granted via their LDAP account which should be
+configured with a valid SSH public key.
+
+Once you have access to the host, any files you host in your `public` folder
+(i.e. `/home/joe/public`) are made accessible via `https://pydis.wtf/~username/`.
+
+By default, an autoindex page will be returned for each folder in this directory
+allowing anyone to view file contents.
+
+If you wish to disable this or wish to display some other content at that
+location (i.e. a landing page) you can create an `index.html` file anywhere
+which will be returned to browsing users.
+
+If you require any help with setting this up please let other members of the
+DevOps team know.