peterwood/shell
1
0
Fork 0
mirror of https://github.com/acedanger/shell.git synced 2025-12-05 21:40:12 -08:00
Code Issues 19 Packages Projects Releases Wiki Activity

immich-backup.sh --help runs backup #11

New Issue
Closed
opened 2025-10-29 19:44:55 -07:00 by peterwood · 1 comment
peterwood commented 2025-10-29 19:44:55 -07:00
Owner
Copy Link

Originally created by @acedanger on GitHub (May 27, 2025).

Originally assigned to: @acedanger on GitHub.

Executing ./shell/immich/backup-immich.sh --help runs the backup.

I would expect to see the usage options and not running the backup logic.

Originally created by @acedanger on GitHub (May 27, 2025). Originally assigned to: @acedanger on GitHub. Executing `./shell/immich/backup-immich.sh --help` runs the backup. I would expect to see the usage options and not running the backup logic.
peterwood added the bug label 2025-10-29 19:44:55 -07:00
peterwood commented 2025-10-29 19:44:55 -07:00
Author
Owner
Copy Link

@acedanger commented on GitHub (May 28, 2025):

Issue Fixed ✅

The script has been successfully updated to properly handle the flag. Instead of executing the backup when is used, the script now displays comprehensive usage information and exits cleanly.

Changes Made:

  1. Added proper argument parsing - The script now processes command-line arguments before any backup operations
  2. Added comprehensive help function - Detailed usage information with examples, configuration requirements, and restore instructions
  3. Added additional helpful features:
    • : Preview backup plan without executing
    • : Skip B2 upload (local backup only)
    • : Enable verbose logging

Testing Completed:

  • ✅ Loading environment variables from ./immich/../.env
    Immich Complete Backup Script
    This script creates a complete backup of the Immich installation including:
  1. Postgres database (using pg_dumpall as recommended by Immich)
  2. User upload directories (photos, videos, and metadata)
USAGE:
    backup-immich.sh [OPTIONS]

OPTIONS:
    --help, -h          Show this help message and exit
    --dry-run          Show what would be backed up without performing actual backup
    --no-upload        Skip B2 upload (local backup only)
    --verbose          Enable verbose logging

CONFIGURATION:
This script requires a .env file in the parent directory with:
- DB_USERNAME=<database_username>
- DB_DATABASE_NAME=<database_name>
- UPLOAD_LOCATION=<path_to_upload_directory>

OPTIONAL B2 CONFIGURATION:
- B2_APPLICATION_KEY_ID=<your_b2_app_key_id>
- B2_APPLICATION_KEY=<your_b2_app_key>
- B2_BUCKET_NAME=<your_b2_bucket_name>

OPTIONAL WEBHOOK CONFIGURATION:
- WEBHOOK_URL=<your_notification_webhook_url>

EXAMPLES:

backup-immich.sh              # Run full backup
backup-immich.sh --help       # Show this help
backup-immich.sh --dry-run    # Preview backup without executing
backup-immich.sh --no-upload  # Backup locally only (skip B2)

RESTORE INSTRUCTIONS:
https://immich.app/docs/administration/backup-and-restore/

Running cleanup... now displays help and exits

  • ✅ Loading environment variables from ./immich/../.env
    Immich Complete Backup Script
    This script creates a complete backup of the Immich installation including:
  1. Postgres database (using pg_dumpall as recommended by Immich)
  2. User upload directories (photos, videos, and metadata)
USAGE:
    backup-immich.sh [OPTIONS]

OPTIONS:
    --help, -h          Show this help message and exit
    --dry-run          Show what would be backed up without performing actual backup
    --no-upload        Skip B2 upload (local backup only)
    --verbose          Enable verbose logging

CONFIGURATION:
This script requires a .env file in the parent directory with:
- DB_USERNAME=<database_username>
- DB_DATABASE_NAME=<database_name>
- UPLOAD_LOCATION=<path_to_upload_directory>

OPTIONAL B2 CONFIGURATION:
- B2_APPLICATION_KEY_ID=<your_b2_app_key_id>
- B2_APPLICATION_KEY=<your_b2_app_key>
- B2_BUCKET_NAME=<your_b2_bucket_name>

OPTIONAL WEBHOOK CONFIGURATION:
- WEBHOOK_URL=<your_notification_webhook_url>

EXAMPLES:

backup-immich.sh                       # Run full backup
backup-immich.sh --help            # Show this help
backup-immich.sh --dry-run       # Preview backup without executing
backup-immich.sh --no-upload  # Backup locally only (skip B2)

RESTORE INSTRUCTIONS:
https://immich.app/docs/administration/backup-and-restore/

Running cleanup... also works correctly

  • ✅ Loading environment variables from ./immich/../.env

=== DRY RUN MODE - NO ACTUAL BACKUP WILL BE PERFORMED ===

Configuration:

  • Database: immich
  • Username: postgres
  • Upload Location: /mnt/share/media/immich/uploads
  • Container: immich_postgres
  • Backup Directory: ./immich/../immich_backups

Would create:

  • Database backup: ./immich/../immich_backups/immich_db_backup_20250527_213504.sql.gz
  • Upload backup: ./immich/../immich_backups/immich_uploads_20250527_213504.tar.gz

Container Status Check:
✓ immich_server: Running (would pause during backup)
✓ immich_postgres: Running
✓ Upload directory: /mnt/share/media/immich/uploads (80G)

B2 Upload Configuration:
✓ B2 configured - would upload to bucket: immich-europa
✓ B2 CLI found at: ./immich/b2-linux

=== DRY RUN COMPLETE - No files were created or modified ===
Running cleanup... provides preview functionality

  • ✅ Invalid options display error and help text

The bug reported in this issue has been completely resolved. The script now behaves as expected - showing help instead of running a backup when the flag is used.

@acedanger commented on GitHub (May 28, 2025): ## Issue Fixed ✅ The script has been successfully updated to properly handle the flag. Instead of executing the backup when is used, the script now displays comprehensive usage information and exits cleanly. ### Changes Made: 1. **Added proper argument parsing** - The script now processes command-line arguments before any backup operations 2. **Added comprehensive help function** - Detailed usage information with examples, configuration requirements, and restore instructions 3. **Added additional helpful features**: - : Preview backup plan without executing - : Skip B2 upload (local backup only) - : Enable verbose logging ### Testing Completed: - ✅ Loading environment variables from ./immich/../.env Immich Complete Backup Script This script creates a complete backup of the Immich installation including: 1. Postgres database (using pg_dumpall as recommended by Immich) 2. User upload directories (photos, videos, and metadata) ``` USAGE: backup-immich.sh [OPTIONS] OPTIONS: --help, -h Show this help message and exit --dry-run Show what would be backed up without performing actual backup --no-upload Skip B2 upload (local backup only) --verbose Enable verbose logging ``` CONFIGURATION: This script requires a .env file in the parent directory with: - DB_USERNAME=<database_username> - DB_DATABASE_NAME=<database_name> - UPLOAD_LOCATION=<path_to_upload_directory> OPTIONAL B2 CONFIGURATION: - B2_APPLICATION_KEY_ID=<your_b2_app_key_id> - B2_APPLICATION_KEY=<your_b2_app_key> - B2_BUCKET_NAME=<your_b2_bucket_name> OPTIONAL WEBHOOK CONFIGURATION: - WEBHOOK_URL=<your_notification_webhook_url> EXAMPLES: ``` backup-immich.sh # Run full backup backup-immich.sh --help # Show this help backup-immich.sh --dry-run # Preview backup without executing backup-immich.sh --no-upload # Backup locally only (skip B2) ``` RESTORE INSTRUCTIONS: https://immich.app/docs/administration/backup-and-restore/ Running cleanup... now displays help and exits - ✅ Loading environment variables from ./immich/../.env Immich Complete Backup Script This script creates a complete backup of the Immich installation including: 1. Postgres database (using pg_dumpall as recommended by Immich) 2. User upload directories (photos, videos, and metadata) ``` USAGE: backup-immich.sh [OPTIONS] OPTIONS: --help, -h Show this help message and exit --dry-run Show what would be backed up without performing actual backup --no-upload Skip B2 upload (local backup only) --verbose Enable verbose logging ``` CONFIGURATION: This script requires a .env file in the parent directory with: - DB_USERNAME=<database_username> - DB_DATABASE_NAME=<database_name> - UPLOAD_LOCATION=<path_to_upload_directory> OPTIONAL B2 CONFIGURATION: - B2_APPLICATION_KEY_ID=<your_b2_app_key_id> - B2_APPLICATION_KEY=<your_b2_app_key> - B2_BUCKET_NAME=<your_b2_bucket_name> OPTIONAL WEBHOOK CONFIGURATION: - WEBHOOK_URL=<your_notification_webhook_url> EXAMPLES: ``` backup-immich.sh # Run full backup backup-immich.sh --help # Show this help backup-immich.sh --dry-run # Preview backup without executing backup-immich.sh --no-upload # Backup locally only (skip B2) ``` RESTORE INSTRUCTIONS: https://immich.app/docs/administration/backup-and-restore/ Running cleanup... also works correctly - ✅ Loading environment variables from ./immich/../.env === DRY RUN MODE - NO ACTUAL BACKUP WILL BE PERFORMED === Configuration: - Database: immich - Username: postgres - Upload Location: /mnt/share/media/immich/uploads - Container: immich_postgres - Backup Directory: ./immich/../immich_backups Would create: - Database backup: ./immich/../immich_backups/immich_db_backup_20250527_213504.sql.gz - Upload backup: ./immich/../immich_backups/immich_uploads_20250527_213504.tar.gz Container Status Check: ✓ immich_server: Running (would pause during backup) ✓ immich_postgres: Running ✓ Upload directory: /mnt/share/media/immich/uploads (80G) B2 Upload Configuration: ✓ B2 configured - would upload to bucket: immich-europa ✓ B2 CLI found at: ./immich/b2-linux === DRY RUN COMPLETE - No files were created or modified === Running cleanup... provides preview functionality - ✅ Invalid options display error and help text The bug reported in this issue has been completely resolved. The script now behaves as expected - showing help instead of running a backup when the flag is used.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
automation
automation
backup-system
backup-system
backup-system
bug
critical
critical
dashboard
database
database
documentation
email
enhancement
enhancement
enhancement
future-enhancement
health-check
health-reporting
high-priority
monitoring
monitoring
notifications
plex
plex
repair
tui
ui
No Label bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
peterwood
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: peterwood/shell#11
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?