docs: update to match v4 (#77)

Author: LouisHaftmann

docs/content/1.getting-started/1.index.md

@@ -49,6 +49,24 @@ The storage driver to use for storing cache data. For more information, see [Sto
 
 The database driver to use for storing cache metadata. For more information, see [Database Drivers](/getting-started/database-drivers).
 
+#### `ENABLE_DIRECT_DOWNLOADS`
+
+- Default: `false`
+
+If set to `true`, will send a signed URL to the runner. The runner can then download the cache directly from the storage provider. This is useful if you have a large cache and don't want to proxy the download through the cache server.
+
+## ::u-alert
+
+icon: 'tabler:alert-triangle'
+class: ring-amber-400
+color: amber
+description: The actions runner needs to be able to reach the storage provider directly to use direct downloads.
+variant: subtle
+
+---
+
+::
+
 #### `CLEANUP_OLDER_THAN_DAYS`
 
 - Default: `90`
@@ -59,12 +77,6 @@ The number of days to keep stale cache data and metadata before deleting it. Set
 
 - Default: `3000`
 
-#### `TEMP_DIR`
-
-- Default: `/tmp`
-
-The directory to use for temporary files (like cache upload buffers).
-
 The port the server should listen on.
 
 ## 2. Setup with Self-Hosted Runners
@@ -77,6 +89,18 @@ To leverage the GitHub Actions Cache Server with your self-hosted runners, you'l
 
 For example, if your cache server's `API_BASE_URL` is `http://localhost:3000` and your `URL_ACCESS_TOKEN` is `random_token`, you would set `ACTIONS_CACHE_URL` to `http://localhost:3000/random_token/`.
 
+## ::u-alert
+
+icon: 'tabler:alert-triangle'
+class: ring-amber-400
+color: amber
+description: Make sure to add a trailing slash to the ACTIONS_CACHE_URL environment variable.
+variant: subtle
+
+---
+
+::
+
 ### Getting the Actions Runner to Use the Cache Server
 
 The default self-hosted runner overwrites the `ACTIONS_CACHE_URL` environment variable with the GitHub-hosted cache server URL. To get the runner to use your self-hosted cache server, you'll need to modify the runner binary:

docs/content/1.getting-started/2.storage-drivers.md

@@ -6,4 +6,3 @@ description: A list of storage drivers available for the GitHub Actions Cache Se
 - [File System](/storage-drivers/filesystem)
 - [S3 / MinIO](/storage-drivers/s3)
 - [GCS](/storage-drivers/gcs)
-- [Memory](/storage-drivers/memory)

docs/content/2.storage-drivers/gcs.md

@@ -7,6 +7,18 @@ Driver: `gcs`
 
 This storage driver stores the cache in a GCS bucket.
 
+## ::u-alert
+
+icon: 'tabler:alert-triangle'
+class: ring-amber-400
+color: amber
+description: Because GCS doesn't support out-of-order multipart uploads (as of November 2024), the cache server will upload the parts into a temporary folder. To combine the parts into a single object, it will download all the parts and re-upload the combined object. This means using GCS as your storage driver will use 3x the bandwidth compared to other storage drivers.
+variant: subtle
+
+---
+
+::
+
 ## Configuration
 
 ### `docker-compose` GCS bucket
@@ -25,7 +37,7 @@ services:
 
       STORAGE_DRIVER: gcs
       STORAGE_GCS_BUCKET: gh-actions-cache
-      # Optional, not required if running in GCP
+      # Optional, not required if running on GCP
       STORAGE_GCS_SERVICE_ACCOUNT_KEY: /gcp/config/application_default_credentials.json
     volumes:
       - cache-data:/app/.data

docs/content/2.storage-drivers/memory.md

@@ -26,3 +26,7 @@ The user to authenticate with the PostgreSQL database.
 #### `DB_POSTGRES_PASSWORD`
 
 The password to authenticate with the PostgreSQL database.
+
+#### `DB_POSTGRES_URL`
+
+The full URL to the PostgreSQL database. This is an alternative to the above configuration options.

docs/content/3.database-drivers/postgres.md

@@ -5,6 +5,18 @@ description:
 
 Driver: `sqlite`
 
+## ::u-alert
+
+icon: 'tabler:alert-triangle'
+class: ring-amber-400
+color: amber
+description: It is recommended to use a more robust database driver for production use.
+variant: subtle
+
+---
+
+::
+
 ## Configuration
 
 #### `DB_SQLITE_PATH`

docs/content/3.database-drivers/sqlite.md

@@ -33,15 +33,13 @@ features:
     - title: Storage Drivers
       description: Support for multiple storage drivers like S3, file system, and more.
       icon: i-ph-database-fill
-      to: /
+      to: /getting-started/storage-drivers
       target: _blank
     - title: No Workflow Changes
       description: No need to change any workflow files, just deploy and start using.
       icon: i-simple-icons-githubactions
-      to: /
-      target: _blank
     - title: Self-Hosted
       description: Host your own cache server to keep your data private and increase caching speed.
       icon: i-ph-lock-fill
-      to: /
+      to: /getting-started
       target: _blank

docs/content/index.yml

@@ -13,16 +13,16 @@
   },
   "dependencies": {
     "@iconify-json/ph": "^1.2.1",
-    "@iconify-json/simple-icons": "^1.2.8",
+    "@iconify-json/simple-icons": "^1.2.12",
     "@nuxt/content": "^2.13.4",
-    "@nuxt/fonts": "^0.10.0",
-    "@nuxt/ui-pro": "^1.4.4",
-    "nuxt": "^3.13.2",
+    "@nuxt/fonts": "^0.10.2",
+    "@nuxt/ui-pro": "^1.5.0",
+    "nuxt": "^3.14.1592",
     "ufo": "^1.5.4",
     "vite-plugin-wasm": "^3.3.0"
   },
   "devDependencies": {
-    "@nuxthq/studio": "^2.1.1",
-    "vue-tsc": "^2.1.6"
+    "@nuxthq/studio": "^2.2.1",
+    "vue-tsc": "^2.1.10"
   }
 }