From 91b6a9913b9006ed21a4e5eada5658872dd79a63 Mon Sep 17 00:00:00 2001 From: Daniel Luiz Alves Date: Sun, 6 Jul 2025 02:14:07 -0300 Subject: [PATCH] docs: update UID and GID comments in Docker Compose files for clarity - Enhanced comments for PALMR_UID and PALMR_GID environment variables across multiple Docker Compose files to indicate that users can change these values to match the UID and GID of the user running the container. - Added a note in the quick-start documentation to guide users on adjusting UID and GID for file upload issues, including commands to find the current UID and GID in Linux systems. --- apps/docs/content/docs/3.1-beta/quick-start.mdx | 12 ++++++++++-- docker-compose-bind-mount-example.yaml | 4 ++-- docker-compose-minio.yaml | 4 ++-- docker-compose-s3.yaml | 4 ++-- docker-compose.yaml | 4 ++-- 5 files changed, 18 insertions(+), 10 deletions(-) diff --git a/apps/docs/content/docs/3.1-beta/quick-start.mdx b/apps/docs/content/docs/3.1-beta/quick-start.mdx index 2a673ff..3f2ada9 100644 --- a/apps/docs/content/docs/3.1-beta/quick-start.mdx +++ b/apps/docs/content/docs/3.1-beta/quick-start.mdx @@ -57,8 +57,6 @@ services: - ENABLE_S3=false - ENCRYPTION_KEY=change-this-key-in-production-min-32-chars # CHANGE THIS KEY FOR SECURITY # - SECURE_SITE=false # Set to true if you are using a reverse proxy - - PALMR_UID=1000 # UID for the container processes (default is 1001) - - PALMR_GID=1000 # GID for the container processes (default is 1001) ports: - "5487:5487" # Web interface - "3333:3333" # API port (OPTIONAL EXPOSED - ONLY IF YOU WANT TO ACCESS THE API DIRECTLY) @@ -70,6 +68,16 @@ volumes: palmr_data: ``` +> **Note:** If you haveing problem with uploading files, try to change the `PALMR_UID` and `PALMR_GID` to the UID and GID of the user running the container. You can find the UID and GID of the user running the container with the command `id -u` and `id -g`. in Linux systems the default user is `1000` and the default group is `1000`. For test you can add the environment variables below to the `docker-compose.yaml` file and restart the container. + +```yaml +environment: + - PALMR_UID=1000 # UID for the container processes (default is 1001) + - PALMR_GID=1000 # GID for the container processes (default is 1001) +``` + +> **Note:** For more information about UID and GID, see our [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) guide. + ### Deployment ```bash diff --git a/docker-compose-bind-mount-example.yaml b/docker-compose-bind-mount-example.yaml index ed41e01..3c88d16 100644 --- a/docker-compose-bind-mount-example.yaml +++ b/docker-compose-bind-mount-example.yaml @@ -5,8 +5,8 @@ services: environment: - ENABLE_S3=false - ENCRYPTION_KEY=change-this-key-in-production-min-32-chars # CHANGE THIS KEY FOR SECURITY - - PALMR_UID=1000 # UID for the container processes (default is 1001) - - PALMR_GID=1000 # GID for the container processes (default is 1001) + - PALMR_UID=1000 # UID for the container processes (default is 1001) you can change it to the UID of the user running the container + - PALMR_GID=1000 # GID for the container processes (default is 1001) you can change it to the GID of the user running the container - SECURE_SITE=false # Set to true if you are using a reverse proxy ports: - "5487:5487" # Web port diff --git a/docker-compose-minio.yaml b/docker-compose-minio.yaml index 9fbbc37..65d6c07 100644 --- a/docker-compose-minio.yaml +++ b/docker-compose-minio.yaml @@ -12,8 +12,8 @@ services: - S3_REGION=${S3_REGION:-us-east-1} # S3 region (us-east-1 is the default region) but it depends on your s3 server region - S3_BUCKET_NAME=${S3_BUCKET_NAME:-palmr-files} # Bucket name for the S3 storage (here we are using palmr-files as the bucket name to understand that this is the bucket for palmr) - S3_FORCE_PATH_STYLE=true # For MinIO compatibility we have to set this to true - - PALMR_UID=1000 # UID for the container processes (default is 1001) - - PALMR_GID=1000 # GID for the container processes (default is 1001) + - PALMR_UID=1000 # UID for the container processes (default is 1001) you can change it to the UID of the user running the container + - PALMR_GID=1000 # GID for the container processes (default is 1001) you can change it to the GID of the user running the container - SECURE_SITE=false # Set to true if you are using a reverse proxy ports: - "5487:5487" # Web port diff --git a/docker-compose-s3.yaml b/docker-compose-s3.yaml index a924f16..254a3ec 100644 --- a/docker-compose-s3.yaml +++ b/docker-compose-s3.yaml @@ -12,8 +12,8 @@ services: - S3_REGION=${S3_REGION:-us-east-1} # S3 region (us-east-1 is the default region) but it depends on your s3 server region - S3_BUCKET_NAME=${S3_BUCKET_NAME:-palmr-files} # Bucket name for the S3 storage (here we are using palmr-files as the bucket name to understand that this is the bucket for palmr) - S3_FORCE_PATH_STYLE=false # For S3 compatibility we have to set this to false - - PALMR_UID=1000 # UID for the container processes (default is 1001) - - PALMR_GID=1000 # GID for the container processes (default is 1001) + - PALMR_UID=1000 # UID for the container processes (default is 1001) you can change it to the UID of the user running the container + - PALMR_GID=1000 # GID for the container processes (default is 1001) you can change it to the GID of the user running the container - SECURE_SITE=false # Set to true if you are using a reverse proxy ports: - "5487:5487" # Web port diff --git a/docker-compose.yaml b/docker-compose.yaml index f2fd43d..2ef3b22 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -8,8 +8,8 @@ services: ports: - "5487:5487" # Web port - "3333:3333" # API port (OPTIONAL EXPOSED - ONLY IF YOU WANT TO ACCESS THE API DIRECTLY) - - PALMR_UID=1000 # UID for the container processes (default is 1001) - - PALMR_GID=1000 # GID for the container processes (default is 1001) + - PALMR_UID=1000 # UID for the container processes (default is 1001) you can change it to the UID of the user running the container + - PALMR_GID=1000 # GID for the container processes (default is 1001) you can change it to the GID of the user running the container - SECURE_SITE=false # Set to true if you are using a reverse proxy volumes: - palmr_data:/app/server # Volume for the application data (changed from /data to /app/server)