feature: add s3 documentation

Author: lukepolo

.vitepress/config.mts

@@ -90,6 +90,13 @@ export default defineConfig({
         text: "Discord Bot",
         link: "/discord-bot",
       },
+      {
+        text: "Custom S3",
+        link: "/s3",
+        items: [
+          { text: "Backblaze + Cloudflare", link: "/s3/backblaze" },
+        ]
+      },
       {
         text: "Custom K8s",
         link: "/custom-k8s",

package.json

@@ -1,10 +1,13 @@
 {
   "devDependencies": {
+    "prettier": "^3.2.5",
     "vitepress": "^1.4.1"
   },
   "scripts": {
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",
-    "docs:preview": "vitepress preview"
+    "docs:preview": "vitepress preview",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
   }
 }

s3/backblaze.md

@@ -0,0 +1,16 @@
+# Backblaze + Cloudflare
+
+Backblaze has a partnership with Cloudflare to provide [free data transfer](https://www.backblaze.com/blog/backblaze-and-cloudflare-partner-to-provide-free-data-transfer/).
+
+To set this up, clone down our [web project](https://github.com/5stackgg/web), then using the following commands to deploy to your cloudfalre instance.
+
+`yarn wrangler secret put S3_SECRET`
+`yarn wrangler secret put S3_ACCESS_KEY`
+`yarn wrangler secret put S3_ENDPOINT`
+`yarn wrangler deploy`
+
+After setting up the Cloudflare Worker, navigate to your panel's application configuration and update the Cloudflare Worker Demo URL.
+
+:::info
+You can find your URL in the [Cloudflare Dashboard](https://dash.cloudflare.com/) under "Workers & Pages" → your worker's settings → "Domains & Routes".
+:::

s3/index.md

@@ -0,0 +1,15 @@
+# Custom S3
+
+5Stack uses S3-compatible storage for storing demos and backups. By default, it uses MinIO which is hosted locally within the Kubernetes cluster.
+
+## Demo Storage
+
+The S3 storage is primarily used for storing match demos and backups. When a match is played, the demos are automatically uploaded to the configured S3 storage.
+
+## Configuration
+
+The default configuration uses MinIO, but you can override this by modifying the following files:
+
+1. Update the S3 `S3_ENDPOINT`, `S3_USE_SSL`, and `S3_PORT` configuration in `<INSTALL_DIR>/base/properties/api-config.env`:
+
+2. Update the S3 credentials in `<INSTALL_DIR>/base/secrets/s3-secrets.env` with your provider's access key and secret key.