Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: update object storage documentation to clarify upload options and sizes

Andrej43ab41caaccb
diff --git a/apps/docs/core/installation/docker-compose.mdx b/apps/docs/core/installation/docker-compose.mdx
index 5aeeacedd..fe74f4160 100644
--- a/apps/docs/core/installation/docker-compose.mdx
+++ b/apps/docs/core/installation/docker-compose.mdx
@@ -65,16 +65,16 @@ Additionally, the following volumes are used:
Kaneo uses S3-compatible object storage for private uploads in task descriptions and comments.
-- Object storage is optional. Kaneo runs without it, but image uploads in task descriptions and comments will be unavailable.
+- Object storage is optional. Kaneo runs without it, but uploads in task descriptions and comments will be unavailable.
- For local/self-hosted setups, MinIO is the recommended option when you want uploads.
-- The Kaneo API creates presigned upload URLs and the browser uploads images directly to the configured storage backend.
+- The Kaneo API creates presigned upload URLs and the browser uploads files directly to the configured storage backend.
- Kaneo serves uploaded assets back through its own API, so the bucket does not need to be public.
- If you do not configure object storage, leave the `S3_*` variables unset.
- For a complete MinIO example and backend-specific setup notes, see the [storage backends guide](/core/installation/storage-backends).
### Optional MinIO service
-Add this service and volume to your `compose.yml` only if you want image uploads:
+Add this service and volume to your `compose.yml` only if you want uploads:
```yml
services:
diff --git a/apps/docs/core/installation/environment-variables.mdx b/apps/docs/core/installation/environment-variables.mdx
index 70b6ecce0..f8ed6eb05 100644
--- a/apps/docs/core/installation/environment-variables.mdx
+++ b/apps/docs/core/installation/environment-variables.mdx
@@ -69,7 +69,7 @@ Name | Description | Default |
| `S3_REGION` | The storage region used for request signing. | `us-east-1` |
| `S3_PUBLIC_BASE_URL` | Optional public base URL for uploaded assets. Kaneo does not require this for the current private asset flow. | |
| `S3_FORCE_PATH_STYLE` | Use path-style S3 URLs. This should usually be `true` for MinIO and `fs`. | `true` |
-| `S3_MAX_IMAGE_UPLOAD_BYTES` | Maximum allowed upload size in bytes. | `10485760` |
+| `S3_MAX_IMAGE_UPLOAD_BYTES` | Maximum allowed upload size in bytes for images and other uploaded files. | `10485760` |
| `S3_PRESIGN_TTL_SECONDS` | How long presigned upload URLs remain valid. | `300` |
### Access Control
diff --git a/apps/docs/core/installation/object-storage-and-image-uploads.mdx b/apps/docs/core/installation/object-storage-and-image-uploads.mdx
index 589616059..5758bf18f 100644
--- a/apps/docs/core/installation/object-storage-and-image-uploads.mdx
+++ b/apps/docs/core/installation/object-storage-and-image-uploads.mdx
@@ -10,7 +10,7 @@ Kaneo supports private uploads in task descriptions and task comments.
Uploads use an S3-compatible object storage backend:
- the Kaneo API creates presigned upload URLs
-- the browser uploads images directly to the storage backend
+- the browser uploads files directly to the storage backend
- Kaneo finalizes uploads into private asset records
- Kaneo serves uploaded files back through its own API
@@ -146,7 +146,7 @@ Optional:
| Name | Description |
| --- | --- |
| `S3_PUBLIC_BASE_URL` | Optional public asset base URL. Kaneo does not require this for the current private asset flow. |
-| `S3_MAX_IMAGE_UPLOAD_BYTES` | Maximum allowed upload size in bytes |
+| `S3_MAX_IMAGE_UPLOAD_BYTES` | Maximum allowed upload size in bytes for images and other uploaded files |
| `S3_PRESIGN_TTL_SECONDS` | Presigned upload URL lifetime |
## Testing uploads