Adding comprehensive comments

This commit is contained in:
2025-07-14 12:48:15 +05:30
parent e57dfa763e
commit ff5ae47bef
22 changed files with 683 additions and 329 deletions

View File

@@ -1,22 +1,31 @@
# Palmr File Transfer Service Configuration
services:
palmr:
# Basic container configuration
container_name: palmr
image: docker.io/kyantech/palmr:v3.1.1-beta
restart: unless-stopped
# Application settings
environment:
- ENABLE_S3=${ENABLE_S3}
- ENCRYPTION_KEY=${ENCRYPTION_KEY}
- SECURE_SITE=${SECURE_SITE}
- PALMR_UID=${PUID}
- PALMR_GID=${PGID}
- ENABLE_S3=${ENABLE_S3} # Enable/Disable S3-compatible storage backend
- ENCRYPTION_KEY=${ENCRYPTION_KEY} # Data encryption key for security
- SECURE_SITE=${SECURE_SITE} # Enable/Disable HTTPS security features
- PALMR_UID=${PUID} # User ID for proper file permissions
- PALMR_GID=${PGID} # Group ID for proper file permissions
# Persistent storage configuration
volumes:
- ${APPDATA_PATH}/palmr/db:/app/server/prisma
- ${DATA_PATH}/palmr/data:/app/server
- ${APPDATA_PATH}/palmr/db:/app/server/prisma # Transfer metadata database
- ${DATA_PATH}/palmr/data:/app/server # File storage directory
# Network configuration
ports:
- ${PORT}:5487
- ${PORT}:5487 # Web interface port
networks:
- frontend
- frontend # Connects to frontend network
# External network definition
networks:
frontend:
external: true
external: true # Uses pre-existing network