From f7d38b3e70ff115391fb3ceb44374371fdbba1be Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 21 Oct 2025 18:47:41 +0000 Subject: [PATCH] docs: enhance SECURE_SITE documentation across all files - Update docker-compose files with clearer SECURE_SITE description - Add Safari cross-site tracking compatibility note to all SECURE_SITE comments - Improve quick-start.mdx environment variable table description - Update all Docker Compose and Docker run examples with enhanced comments Co-authored-by: danielalves96 <62755605+danielalves96@users.noreply.github.com> --- apps/docs/content/docs/3.2-beta/quick-start.mdx | 10 +++++----- docker-compose-bind-mount-example.yaml | 2 +- docker-compose-minio.yaml | 2 +- docker-compose-s3.yaml | 2 +- docker-compose.yaml | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/apps/docs/content/docs/3.2-beta/quick-start.mdx b/apps/docs/content/docs/3.2-beta/quick-start.mdx index 9483af8..504cd1b 100644 --- a/apps/docs/content/docs/3.2-beta/quick-start.mdx +++ b/apps/docs/content/docs/3.2-beta/quick-start.mdx @@ -67,7 +67,7 @@ Choose your storage method based on your needs: # - ENCRYPTION_KEY=your-secure-key-min-32-chars # Required only if encryption is enabled # - PALMR_UID=1000 # UID for the container processes (default is 1000) # - PALMR_GID=1000 # GID for the container processes (default is 1000) - # - SECURE_SITE=false # Set to true if you are using a reverse proxy + # - SECURE_SITE=false # Set to true for HTTPS/reverse proxy (enables cross-origin cookies for Safari) # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (optional, defaults to 3600 seconds / 1 hour) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum simultaneous downloads (auto-scales if not set) @@ -122,7 +122,7 @@ Choose your storage method based on your needs: # - ENCRYPTION_KEY=your-secure-key-min-32-chars # Required only if encryption is enabled # - PALMR_UID=1000 # UID for the container processes (default is 1000) # - PALMR_GID=1000 # GID for the container processes (default is 1000) - # - SECURE_SITE=false # Set to true if you are using a reverse proxy + # - SECURE_SITE=false # Set to true for HTTPS/reverse proxy (enables cross-origin cookies for Safari) # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (optional, defaults to 3600 seconds / 1 hour) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum simultaneous downloads (auto-scales if not set) @@ -168,7 +168,7 @@ Customize Palmr's behavior with these environment variables: | `DISABLE_FILESYSTEM_ENCRYPTION` | `true` | Disable file encryption for better performance (set to `false` to enable encryption) | | `PRESIGNED_URL_EXPIRATION` | `3600` | Duration in seconds for presigned URL expiration (applies to both filesystem and S3 storage) | | `CUSTOM_PATH` | - | Custom base path for disk space detection in manual installations with symlinks | -| `SECURE_SITE` | `false` | Enable secure cookies for HTTPS/reverse proxy deployments | +| `SECURE_SITE` | `false` | Enable secure cookies for HTTPS/reverse proxy deployments. Required for Safari cross-site tracking compatibility when frontend and backend are on different domains | | `DEFAULT_LANGUAGE` | `en-US` | Default application language ([see available languages](/docs/3.2-beta/available-languages)) | | `PALMR_UID` | `1000` | User ID for container processes (helps with file permissions) | | `PALMR_GID` | `1000` | Group ID for container processes (helps with file permissions) | @@ -238,7 +238,7 @@ Prefer Docker commands over Compose? Here are the equivalent commands: # -e ENCRYPTION_KEY=your-secure-key-min-32-chars # Required only if encryption is enabled # -e PALMR_UID=1000 # UID for the container processes (default is 1000) # -e PALMR_GID=1000 # GID for the container processes (default is 1000) - # -e SECURE_SITE=false # Set to true if you are using a reverse proxy + # -e SECURE_SITE=false # Set to true for HTTPS/reverse proxy (enables cross-origin cookies for Safari) # -e DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) -p 5487:5487 \ -p 3333:3333 \ @@ -265,7 +265,7 @@ Prefer Docker commands over Compose? Here are the equivalent commands: # -e ENCRYPTION_KEY=your-secure-key-min-32-chars # Required only if encryption is enabled # -e PALMR_UID=1000 # UID for the container processes (default is 1000) # -e PALMR_GID=1000 # GID for the container processes (default is 1000) - # -e SECURE_SITE=false # Set to true if you are using a reverse proxy + # -e SECURE_SITE=false # Set to true for HTTPS/reverse proxy (enables cross-origin cookies for Safari) # -e DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) -p 5487:5487 \ -p 3333:3333 \ diff --git a/docker-compose-bind-mount-example.yaml b/docker-compose-bind-mount-example.yaml index 323c60a..ec14f49 100644 --- a/docker-compose-bind-mount-example.yaml +++ b/docker-compose-bind-mount-example.yaml @@ -12,7 +12,7 @@ services: # - PALMR_GID=1000 # GID for the container processes (OPTIONAL - default is 1000) | See our UID/GID Documentation for more information # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) | See the docs for see all supported languages # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (OPTIONAL - default is 3600 seconds / 1 hour) - # - SECURE_SITE=true # Set to true if you are using a reverse proxy (OPTIONAL - default is false) + # - SECURE_SITE=true # Set to true for HTTPS/reverse proxy deployments. Enables cross-origin cookies for Safari compatibility (OPTIONAL - default is false) # Download Memory Management Configuration (OPTIONAL - See documentation for details) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum number of simultaneous downloads (OPTIONAL - auto-scales based on system memory if not set) diff --git a/docker-compose-minio.yaml b/docker-compose-minio.yaml index 6c1d491..2e30aa2 100644 --- a/docker-compose-minio.yaml +++ b/docker-compose-minio.yaml @@ -17,7 +17,7 @@ services: # - PALMR_GID=1000 # GID for the container processes (OPTIONAL - default is 1000) | See our UID/GID Documentation for more information # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) | See the docs for see all supported languages # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (OPTIONAL - default is 3600 seconds / 1 hour) - # - SECURE_SITE=true # Set to true if you are using a reverse proxy (OPTIONAL - default is false) + # - SECURE_SITE=true # Set to true for HTTPS/reverse proxy deployments. Enables cross-origin cookies for Safari compatibility (OPTIONAL - default is false) # Download Memory Management Configuration (OPTIONAL - See documentation for details) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum number of simultaneous downloads (OPTIONAL - auto-scales based on system memory if not set) diff --git a/docker-compose-s3.yaml b/docker-compose-s3.yaml index a8e8ff5..4712c98 100644 --- a/docker-compose-s3.yaml +++ b/docker-compose-s3.yaml @@ -17,7 +17,7 @@ services: # - PALMR_GID=1000 # GID for the container processes (OPTIONAL - default is 1000) | See our UID/GID Documentation for more information # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) | See the docs for see all supported languages # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (OPTIONAL - default is 3600 seconds / 1 hour) - # - SECURE_SITE=true # Set to true if you are using a reverse proxy (OPTIONAL - default is false) + # - SECURE_SITE=true # Set to true for HTTPS/reverse proxy deployments. Enables cross-origin cookies for Safari compatibility (OPTIONAL - default is false) # Download Memory Management Configuration (OPTIONAL - See documentation for details) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum number of simultaneous downloads (OPTIONAL - auto-scales based on system memory if not set) diff --git a/docker-compose.yaml b/docker-compose.yaml index a14c102..d1f3a56 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -12,7 +12,7 @@ services: # - PALMR_GID=1000 # GID for the container processes (OPTIONAL - default is 1000) | See our UID/GID Documentation for more information # - DEFAULT_LANGUAGE=en-US # Default language for the application (optional, defaults to en-US) | See the docs to see all supported languages # - PRESIGNED_URL_EXPIRATION=3600 # Duration in seconds for presigned URL expiration (OPTIONAL - default is 3600 seconds / 1 hour) - # - SECURE_SITE=true # Set to true if you are using a reverse proxy (OPTIONAL - default is false) + # - SECURE_SITE=true # Set to true for HTTPS/reverse proxy deployments. Enables cross-origin cookies for Safari compatibility (OPTIONAL - default is false) # Download Memory Management Configuration (OPTIONAL - See documentation for details) # - DOWNLOAD_MAX_CONCURRENT=5 # Maximum number of simultaneous downloads (OPTIONAL - auto-scales based on system memory if not set)