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.
This commit is contained in:
Daniel Luiz Alves
2025-07-06 02:14:07 -03:00
parent 84dc949d5c
commit 91b6a9913b
5 changed files with 18 additions and 10 deletions

View File

@@ -57,8 +57,6 @@ services:
- ENABLE_S3=false - ENABLE_S3=false
- ENCRYPTION_KEY=change-this-key-in-production-min-32-chars # CHANGE THIS KEY FOR SECURITY - 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 # - 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: ports:
- "5487:5487" # Web interface - "5487:5487" # Web interface
- "3333:3333" # API port (OPTIONAL EXPOSED - ONLY IF YOU WANT TO ACCESS THE API DIRECTLY) - "3333:3333" # API port (OPTIONAL EXPOSED - ONLY IF YOU WANT TO ACCESS THE API DIRECTLY)
@@ -70,6 +68,16 @@ volumes:
palmr_data: 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 ### Deployment
```bash ```bash

View File

@@ -5,8 +5,8 @@ services:
environment: environment:
- ENABLE_S3=false - ENABLE_S3=false
- ENCRYPTION_KEY=change-this-key-in-production-min-32-chars # CHANGE THIS KEY FOR SECURITY - 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_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) - 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 - SECURE_SITE=false # Set to true if you are using a reverse proxy
ports: ports:
- "5487:5487" # Web port - "5487:5487" # Web port

View File

@@ -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_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_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 - 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_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) - 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 - SECURE_SITE=false # Set to true if you are using a reverse proxy
ports: ports:
- "5487:5487" # Web port - "5487:5487" # Web port

View File

@@ -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_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_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 - 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_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) - 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 - SECURE_SITE=false # Set to true if you are using a reverse proxy
ports: ports:
- "5487:5487" # Web port - "5487:5487" # Web port

View File

@@ -8,8 +8,8 @@ services:
ports: ports:
- "5487:5487" # Web port - "5487:5487" # Web port
- "3333:3333" # API port (OPTIONAL EXPOSED - ONLY IF YOU WANT TO ACCESS THE API DIRECTLY) - "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_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) - 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 - SECURE_SITE=false # Set to true if you are using a reverse proxy
volumes: volumes:
- palmr_data:/app/server # Volume for the application data (changed from /data to /app/server) - palmr_data:/app/server # Volume for the application data (changed from /data to /app/server)