mirror of
https://github.com/kyantech/Palmr.git
synced 2025-10-22 22:02:00 +00:00
feat: Enhance Docker setup and documentation for Palmr.
- Added a new `docker-compose-bind-mount-example.yaml` for easier bind mount configuration. - Updated `.gitignore` to include the `data/` directory for persistent storage. - Modified `docker-compose.yaml` to clarify volume paths and improve comments. - Enhanced `Dockerfile` to support flexible UID/GID configuration and ensure proper directory permissions. - Updated environment variable handling in `server-start.sh` and Prisma configuration for better database management. - Revised documentation in `quick-start.mdx` and `uid-gid-configuration.mdx` to reflect new features and best practices for deployment.
This commit is contained in:
92
Dockerfile
92
Dockerfile
@@ -1,10 +1,11 @@
|
||||
FROM node:20-alpine AS base
|
||||
|
||||
# Install system dependencies (removed netcat-openbsd since we no longer need to wait for PostgreSQL)
|
||||
# Install system dependencies
|
||||
RUN apk add --no-cache \
|
||||
gcompat \
|
||||
supervisor \
|
||||
curl
|
||||
curl \
|
||||
su-exec
|
||||
|
||||
# Enable pnpm
|
||||
RUN corepack enable pnpm
|
||||
@@ -80,15 +81,12 @@ ARG PALMR_GID=1001
|
||||
RUN addgroup --system --gid ${PALMR_GID} nodejs
|
||||
RUN adduser --system --uid ${PALMR_UID} --ingroup nodejs palmr
|
||||
|
||||
# Create application directories and set permissions
|
||||
# Include storage directories for filesystem mode and SQLite database directory
|
||||
RUN mkdir -p /app/server /app/web /home/palmr/.npm /home/palmr/.cache \
|
||||
/app/server/uploads /app/server/temp-chunks /app/server/uploads/logo \
|
||||
/app/server/prisma
|
||||
# Create application directories
|
||||
RUN mkdir -p /app/palmr-app /app/web /home/palmr/.npm /home/palmr/.cache
|
||||
RUN chown -R palmr:nodejs /app /home/palmr
|
||||
|
||||
# === Copy Server Files ===
|
||||
WORKDIR /app/server
|
||||
# === Copy Server Files to /app/palmr-app (separate from /app/server for bind mounts) ===
|
||||
WORKDIR /app/palmr-app
|
||||
|
||||
# Copy server production files
|
||||
COPY --from=server-builder --chown=palmr:nodejs /app/server/dist ./dist
|
||||
@@ -101,8 +99,9 @@ COPY --from=server-builder --chown=palmr:nodejs /app/server/reset-password.sh ./
|
||||
COPY --from=server-builder --chown=palmr:nodejs /app/server/src/scripts/ ./src/scripts/
|
||||
RUN chmod +x ./reset-password.sh
|
||||
|
||||
# Ensure storage directories have correct permissions
|
||||
RUN chown -R palmr:nodejs /app/server/uploads /app/server/temp-chunks /app/server/prisma
|
||||
# Copy seed file to the shared location for bind mounts
|
||||
RUN mkdir -p /app/server/prisma
|
||||
COPY --from=server-builder --chown=palmr:nodejs /app/server/prisma/seed.js /app/server/prisma/seed.js
|
||||
|
||||
# === Copy Web Files ===
|
||||
WORKDIR /app/web
|
||||
@@ -123,7 +122,7 @@ COPY infra/server-start.sh /app/server-start.sh
|
||||
RUN chmod +x /app/server-start.sh
|
||||
RUN chown palmr:nodejs /app/server-start.sh
|
||||
|
||||
# Copy supervisor configuration (simplified without PostgreSQL dependency)
|
||||
# Copy supervisor configuration (updated paths)
|
||||
COPY <<EOF /etc/supervisor/conf.d/supervisord.conf
|
||||
[supervisord]
|
||||
nodaemon=true
|
||||
@@ -132,9 +131,9 @@ logfile=/var/log/supervisor/supervisord.log
|
||||
pidfile=/var/run/supervisord.pid
|
||||
|
||||
[program:server]
|
||||
command=/app/server-start.sh
|
||||
directory=/app/server
|
||||
user=palmr
|
||||
command=/bin/sh -c "export DATABASE_URL='file:/app/server/prisma/palmr.db' && export UPLOAD_PATH='/app/server/uploads' && export TEMP_CHUNKS_PATH='/app/server/temp-chunks' && /app/server-start.sh"
|
||||
directory=/app/palmr-app
|
||||
user=root
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stderr_logfile=/var/log/supervisor/server.err.log
|
||||
@@ -155,7 +154,7 @@ priority=200
|
||||
startsecs=10
|
||||
EOF
|
||||
|
||||
# Create main startup script with UID/GID runtime support
|
||||
# Create main startup script
|
||||
COPY <<EOF /app/start.sh
|
||||
#!/bin/sh
|
||||
set -e
|
||||
@@ -164,56 +163,15 @@ echo "Starting Palmr Application..."
|
||||
echo "Storage Mode: \${ENABLE_S3:-false}"
|
||||
echo "Database: SQLite"
|
||||
|
||||
# Runtime UID/GID configuration - only apply if environment variables are set
|
||||
if [ -n "\${PALMR_UID}" ] || [ -n "\${PALMR_GID}" ]; then
|
||||
RUNTIME_UID=\${PALMR_UID:-${PALMR_UID}}
|
||||
RUNTIME_GID=\${PALMR_GID:-${PALMR_GID}}
|
||||
|
||||
echo "Runtime UID/GID configuration detected: UID=\$RUNTIME_UID, GID=\$RUNTIME_GID"
|
||||
|
||||
# Get current user/group IDs
|
||||
CURRENT_UID=\$(id -u palmr 2>/dev/null || echo "${PALMR_UID}")
|
||||
CURRENT_GID=\$(id -g palmr 2>/dev/null || echo "${PALMR_GID}")
|
||||
|
||||
# Only modify if different from current
|
||||
if [ "\$CURRENT_UID" != "\$RUNTIME_UID" ] || [ "\$CURRENT_GID" != "\$RUNTIME_GID" ]; then
|
||||
echo "Adjusting user/group IDs from \$CURRENT_UID:\$CURRENT_GID to \$RUNTIME_UID:\$RUNTIME_GID"
|
||||
|
||||
# Modify group if needed
|
||||
if [ "\$CURRENT_GID" != "\$RUNTIME_GID" ]; then
|
||||
if getent group \$RUNTIME_GID >/dev/null 2>&1; then
|
||||
EXISTING_GROUP=\$(getent group \$RUNTIME_GID | cut -d: -f1)
|
||||
echo "Using existing group with GID \$RUNTIME_GID: \$EXISTING_GROUP"
|
||||
usermod -g \$EXISTING_GROUP palmr 2>/dev/null || echo "Warning: Could not change user group"
|
||||
else
|
||||
groupmod -g \$RUNTIME_GID nodejs 2>/dev/null || echo "Warning: Could not modify group GID"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Modify user if needed
|
||||
if [ "\$CURRENT_UID" != "\$RUNTIME_UID" ]; then
|
||||
if getent passwd \$RUNTIME_UID >/dev/null 2>&1; then
|
||||
EXISTING_USER=\$(getent passwd \$RUNTIME_UID | cut -d: -f1)
|
||||
echo "Warning: UID \$RUNTIME_UID already exists as user '\$EXISTING_USER'"
|
||||
echo "Container will continue but may have permission issues"
|
||||
else
|
||||
usermod -u \$RUNTIME_UID palmr 2>/dev/null || echo "Warning: Could not modify user UID"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Update file ownership for application directories
|
||||
echo "Updating file ownership for application directories..."
|
||||
chown -R palmr:nodejs /app /home/palmr 2>/dev/null || echo "Warning: Could not update all file ownership"
|
||||
else
|
||||
echo "Runtime UID/GID matches current values, no changes needed"
|
||||
fi
|
||||
else
|
||||
echo "No runtime UID/GID configuration provided, using defaults"
|
||||
fi
|
||||
# Set global environment variables
|
||||
export DATABASE_URL="file:/app/server/prisma/palmr.db"
|
||||
export UPLOAD_PATH="/app/server/uploads"
|
||||
export TEMP_CHUNKS_PATH="/app/server/temp-chunks"
|
||||
|
||||
# Ensure storage directories exist with correct permissions
|
||||
# Ensure /app/server directory exists for bind mounts
|
||||
mkdir -p /app/server/uploads /app/server/temp-chunks /app/server/uploads/logo /app/server/prisma
|
||||
chown -R palmr:nodejs /app/server/uploads /app/server/temp-chunks /app/server/prisma 2>/dev/null || echo "Warning: Could not set permissions on storage directories"
|
||||
|
||||
echo "Data directories ready for first run..."
|
||||
|
||||
# Start supervisor
|
||||
exec /usr/bin/supervisord -c /etc/supervisor/conf.d/supervisord.conf
|
||||
@@ -221,8 +179,8 @@ EOF
|
||||
|
||||
RUN chmod +x /app/start.sh
|
||||
|
||||
# Create volume mount points for persistent storage (filesystem mode and SQLite database)
|
||||
VOLUME ["/app/server/uploads", "/app/server/temp-chunks", "/app/server/prisma"]
|
||||
# Create volume mount points for bind mounts
|
||||
VOLUME ["/app/server"]
|
||||
|
||||
# Expose ports
|
||||
EXPOSE 3333 5487
|
||||
@@ -232,4 +190,4 @@ HEALTHCHECK --interval=30s --timeout=10s --start-period=60s --retries=3 \
|
||||
CMD curl -f http://localhost:5487 || exit 1
|
||||
|
||||
# Start application
|
||||
CMD ["/app/start.sh"]
|
||||
CMD ["/app/start.sh"]
|
Reference in New Issue
Block a user