diff --git a/DEPLOYMENT_GUIDE.md b/DEPLOYMENT_GUIDE.md index 6d818f5..ecfd19b 100644 --- a/DEPLOYMENT_GUIDE.md +++ b/DEPLOYMENT_GUIDE.md @@ -7,9 +7,9 @@ This guide covers multiple deployment options for PicPeak, from simple local set For the easiest installation without Docker or complex configurations, use our **unified setup script**: ```bash -curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/setup.sh -o setup.sh && \ -chmod +x setup.sh && \ -sudo ./setup.sh +curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/picpeak-setup.sh -o picpeak-setup.sh && \ +chmod +x picpeak-setup.sh && \ +sudo ./picpeak-setup.sh ``` This automated script handles everything including: @@ -424,10 +424,10 @@ If you lose your admin credentials after the first login, you'll need to manuall ```bash # Native reinstall example -sudo ./setup.sh --native --force-admin-password-reset +sudo ./picpeak-setup.sh --native --force-admin-password-reset # Docker reinstall example -sudo ./setup.sh --docker --force-admin-password-reset +sudo ./picpeak-setup.sh --docker --force-admin-password-reset ``` The flag calls `scripts/reset-admin-password.js` in non-interactive mode, writes a fresh random password into `data/ADMIN_CREDENTIALS.txt`, and prints the new credentials at the end of the installer run. diff --git a/SIMPLE_SETUP.md b/SIMPLE_SETUP.md index 7ea7df4..c5f80d7 100644 --- a/SIMPLE_SETUP.md +++ b/SIMPLE_SETUP.md @@ -8,9 +8,9 @@ This guide provides easy installation instructions for PicPeak on Linux servers ```bash # Download and run the unified setup script -curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/setup.sh -o setup.sh && \ -chmod +x setup.sh && \ -sudo ./setup.sh +curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/picpeak-setup.sh -o picpeak-setup.sh && \ +chmod +x picpeak-setup.sh && \ +sudo ./picpeak-setup.sh ``` The script will automatically detect your environment and recommend the best installation method. @@ -21,7 +21,7 @@ The script will automatically detect your environment and recommend the best ins Best for: Most users, easy updates, isolated environment ```bash -sudo ./setup.sh --docker +sudo ./picpeak-setup.sh --docker ``` **Pros:** @@ -38,7 +38,7 @@ sudo ./setup.sh --docker Best for: Resource-constrained systems, Raspberry Pi, direct control ```bash -sudo ./setup.sh --native +sudo ./picpeak-setup.sh --native ``` **Pros:** @@ -73,7 +73,7 @@ sudo ./setup.sh --native ### Interactive Mode (Default) ```bash -sudo ./setup.sh +sudo ./picpeak-setup.sh ``` The script will prompt you to choose: @@ -87,7 +87,7 @@ The script will prompt you to choose: #### Docker with full configuration: ```bash -sudo ./setup.sh --docker --unattended \ +sudo ./picpeak-setup.sh --docker --unattended \ --domain photos.example.com \ --email admin@example.com \ --admin-password SecurePass123 \ @@ -100,7 +100,7 @@ sudo ./setup.sh --docker --unattended \ #### Native with minimal configuration: ```bash -sudo ./setup.sh --native --unattended \ +sudo ./picpeak-setup.sh --native --unattended \ --email admin@example.com \ --admin-password SecurePass123 ``` @@ -293,7 +293,7 @@ sudo systemctl restart picpeak-backend picpeak-workers # Update PicPeak # (reruns migrations to pick up schema fixes for native installs) -sudo ./setup.sh --update +sudo ./picpeak-setup.sh --update ``` ## ⚙️ Configuration @@ -385,14 +385,14 @@ docker compose pull docker compose up -d # Native -sudo ./setup.sh --update +sudo ./picpeak-setup.sh --update ``` ### Uninstall ```bash # Will prompt for confirmation and data removal options -sudo ./setup.sh --uninstall +sudo ./picpeak-setup.sh --uninstall ``` ## 🐛 Troubleshooting @@ -508,13 +508,13 @@ sudo systemctl restart picpeak-backend ### Home/Office Network ```bash # Simple local setup without domain -sudo ./setup.sh --native --email admin@local.com +sudo ./picpeak-setup.sh --native --email admin@local.com ``` ### Public Website with HTTPS ```bash # Full production setup -sudo ./setup.sh --docker \ +sudo ./picpeak-setup.sh --docker \ --domain photos.company.com \ --email admin@company.com \ --enable-ssl @@ -523,7 +523,7 @@ sudo ./setup.sh --docker \ ### Raspberry Pi Setup ```bash # Optimized for ARM devices -sudo ./setup.sh --native \ +sudo ./picpeak-setup.sh --native \ --port 8080 \ --email pi@local.com ``` diff --git a/docs/ADMIN_SETUP_GUIDE.md b/docs/ADMIN_SETUP_GUIDE.md index 4f13c14..73f3086 100644 --- a/docs/ADMIN_SETUP_GUIDE.md +++ b/docs/ADMIN_SETUP_GUIDE.md @@ -109,7 +109,7 @@ If ADMIN_CREDENTIALS.txt is missing: - File is created in the backend directory root - File might have been deleted for security (as recommended) - Regenerate it by running `node scripts/reset-admin-password.js --force --credentials-file data/ADMIN_CREDENTIALS.txt` -- When using the unified `setup.sh` installer for a reinstall, append `--force-admin-password-reset` to have the script perform the reset automatically +- When using the unified `picpeak-setup.sh` installer for a reinstall, append `--force-admin-password-reset` to have the script perform the reset automatically ## Best Practices diff --git a/scripts/setup.sh b/scripts/picpeak-setup.sh similarity index 99% rename from scripts/setup.sh rename to scripts/picpeak-setup.sh index 7e63b54..2c99bfd 100755 --- a/scripts/setup.sh +++ b/scripts/picpeak-setup.sh @@ -2,7 +2,7 @@ ################################################################################ # PicPeak Unified Setup Script -# Version: 2.0.0 +# Version: 2.1.0 # Description: Universal installer for PicPeak with Docker and Native options # Supports: Ubuntu, Debian, Fedora, RHEL/CentOS, Raspberry Pi OS ################################################################################ @@ -11,7 +11,7 @@ set -euo pipefail IFS=$'\n\t' # Script configuration -readonly SCRIPT_VERSION="2.0.0" +readonly SCRIPT_VERSION="2.1.0" readonly APP_NAME="PicPeak" readonly REPO_URL="https://github.com/the-luap/picpeak.git" readonly NODE_VERSION="20"