Document S3 examples and refresh template

CloudronManifest.json

@@ -7,7 +7,7 @@
   "contactEmail": "contact@ente.io",
   "tagline": "Open Source End-to-End Encrypted Photos & Authentication",
   "upstreamVersion": "1.0.0",
-  "version": "0.1.118",
+  "version": "0.1.121",
   "healthCheckPath": "/ping",
   "httpPort": 3080,
   "memoryLimit": 1073741824,

POSTINSTALL.md

@@ -7,16 +7,12 @@ Before you can use Ente, you need to configure an S3-compatible storage service:
 1. Go to your Cloudron dashboard
 2. Click on your Ente app
 3. Click on "Terminal"
-4. Edit the S3 configuration template:
+4. Edit the S3 configuration file:
    ```
-   nano /app/data/config/s3.env.template
+   nano /app/data/config/s3.env
    ```
-5. Fill in your S3 credentials (AWS S3, MinIO, DigitalOcean Spaces, etc.)
+5. Uncomment the variables you need and fill in your S3 credentials (AWS S3, Cloudflare R2, MinIO, etc.). The file includes commented examples for the previous Wasabi defaults and a generic Cloudflare R2 setup.
-6. Save the file and rename it:
+6. Save the file and restart your Ente app from the Cloudron dashboard
-   ```
-   mv /app/data/config/s3.env.template /app/data/config/s3.env
-   ```
-7. Restart your Ente app from the Cloudron dashboard
 
 ## Next Steps
 

start.sh

@@ -84,16 +84,77 @@ else
 fi
 RP_ID="${CLOUDRON_APP_FQDN:-${CLOUDRON_APP_DOMAIN:-localhost}}"
 
-# S3 configuration - HARDCODED VALUES
+# S3 configuration (overridable post-install)
-S3_ACCESS_KEY="QZ5M3VMBUHDTIFDFCD8E"
+DEFAULT_S3_ACCESS_KEY="QZ5M3VMBUHDTIFDFCD8E"
-S3_SECRET_KEY="pz1eHYjU1NwAbbruedc7swzCuszd57p1rGSFVzjv"
+DEFAULT_S3_SECRET_KEY="pz1eHYjU1NwAbbruedc7swzCuszd57p1rGSFVzjv"
-S3_ENDPOINT="https://s3.eu-central-2.wasabisys.com"
+DEFAULT_S3_ENDPOINT="https://s3.eu-central-2.wasabisys.com"
+DEFAULT_S3_REGION="eu-central-2"
+DEFAULT_S3_BUCKET="ente-due-ren"
+
+S3_CONFIG_DIR="/app/data/config"
+S3_CONFIG_FILE="$S3_CONFIG_DIR/s3.env"
+
+write_default_s3_template() {
+  cat > "$S3_CONFIG_FILE" << 'EOF'
+# S3 configuration overrides for Ente on Cloudron.
+# Uncomment and set any of the variables below to override the packaged defaults.
+# After editing this file, restart the Ente app from the Cloudron dashboard.
+#
+# Example (previous Wasabi defaults bundled with this package):
+#S3_ACCESS_KEY=QZ5M3VMBUHDTIFDFCD8E
+#S3_SECRET_KEY=pz1eHYjU1NwAbbruedc7swzCuszd57p1rGSFVzjv
+#S3_ENDPOINT=https://s3.eu-central-2.wasabisys.com
+#S3_REGION=eu-central-2
+#S3_BUCKET=ente-due-ren
+#
+# Example (Cloudflare R2 — replace placeholders):
+#S3_ACCESS_KEY=R2_ACCESS_KEY
+#S3_SECRET_KEY=R2_SECRET_KEY
+#S3_ENDPOINT=https://<ACCOUNT_ID>.r2.cloudflarestorage.com
+#S3_REGION=auto
+#S3_BUCKET=<bucket-name>
+#
+#S3_ACCESS_KEY=
+#S3_SECRET_KEY=
+#S3_ENDPOINT=
+#S3_REGION=
+#S3_BUCKET=
+EOF
+  chown cloudron:cloudron "$S3_CONFIG_FILE" || true
+}
+
+mkdir -p "$S3_CONFIG_DIR"
+
+if [ -f "$S3_CONFIG_FILE" ]; then
+  if ! grep -q "previous Wasabi defaults" "$S3_CONFIG_FILE" && ! grep -Eq '^[[:space:]]*[^#[:space:]]' "$S3_CONFIG_FILE"; then
+    log "INFO" "Refreshing S3 configuration template with example values"
+    write_default_s3_template
+  fi
+  log "INFO" "Loading S3 configuration overrides from $S3_CONFIG_FILE"
+  # shellcheck disable=SC1090
+  set -a
+  . "$S3_CONFIG_FILE"
+  set +a
+else
+  log "INFO" "S3 configuration file not found, writing template to $S3_CONFIG_FILE"
+  write_default_s3_template
+fi
+
+S3_ACCESS_KEY="${S3_ACCESS_KEY:-$DEFAULT_S3_ACCESS_KEY}"
+S3_SECRET_KEY="${S3_SECRET_KEY:-$DEFAULT_S3_SECRET_KEY}"
+S3_ENDPOINT="${S3_ENDPOINT:-$DEFAULT_S3_ENDPOINT}"
+S3_REGION="${S3_REGION:-$DEFAULT_S3_REGION}"
+S3_BUCKET="${S3_BUCKET:-$DEFAULT_S3_BUCKET}"
+
 S3_ENDPOINT_HOST="${S3_ENDPOINT#https://}"
 S3_ENDPOINT_HOST="${S3_ENDPOINT_HOST#http://}"
-S3_REGION="eu-central-2"
-S3_BUCKET="ente-due-ren"
 
-log "INFO" "Using hardcoded S3 configuration"
+if [ -z "$S3_ACCESS_KEY" ] || [ -z "$S3_SECRET_KEY" ] || [ -z "$S3_ENDPOINT" ] || [ -z "$S3_REGION" ] || [ -z "$S3_BUCKET" ]; then
+  log "ERROR" "Incomplete S3 configuration detected. Please update $S3_CONFIG_FILE or set environment variables."
+  exit 1
+fi
+
+log "INFO" "Using S3 configuration"
 log "INFO" "S3 Endpoint: $S3_ENDPOINT"
 log "INFO" "S3 Region: $S3_REGION"
 log "INFO" "S3 Bucket: $S3_BUCKET"
@@ -996,7 +1057,7 @@ cat > /app/data/SETUP-INSTRUCTIONS.md << EOF
 
 ## Configuration
 
-1. **S3 Storage**: Edit the configuration file at \`/app/data/s3.env\` with your S3-compatible storage credentials.
+1. **S3 Storage**: Edit the configuration file at \`/app/data/config/s3.env\` (uncomment lines and add your values) with your S3-compatible storage credentials.
 
 2. **Museum Server**: The server configuration is at \`/app/data/ente/server/museum.yaml\` if you need to customize settings.