paul/picpeak
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Rename setup script and bump installer version (#39)

Browse Source
This commit is contained in:
Paul Nothaft
2025-10-14 15:48:55 +02:00
parent 52f8f1f738
commit ccb65b892b
4 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEPLOYMENT_GUIDE.md
+5 -5
View File
@@ -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**: For the easiest installation without Docker or complex configurations, use our **unified setup script**:
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/setup.sh -o setup.sh && \ curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/picpeak-setup.sh -o picpeak-setup.sh && \
chmod +x setup.sh && \ chmod +x picpeak-setup.sh && \
sudo ./setup.sh sudo ./picpeak-setup.sh
``` ```
This automated script handles everything including: 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 ```bash
# Native reinstall example # Native reinstall example
sudo ./setup.sh --native --force-admin-password-reset sudo ./picpeak-setup.sh --native --force-admin-password-reset
# Docker reinstall example # 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. 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.
SIMPLE_SETUP.md
+14 -14
View File
@@ -8,9 +8,9 @@ This guide provides easy installation instructions for PicPeak on Linux servers
```bash ```bash
# Download and run the unified setup script # Download and run the unified setup script
curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/setup.sh -o setup.sh && \ curl -fsSL https://raw.githubusercontent.com/the-luap/picpeak/main/scripts/picpeak-setup.sh -o picpeak-setup.sh && \
chmod +x setup.sh && \ chmod +x picpeak-setup.sh && \
sudo ./setup.sh sudo ./picpeak-setup.sh
``` ```
The script will automatically detect your environment and recommend the best installation method. 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 Best for: Most users, easy updates, isolated environment
```bash ```bash
sudo ./setup.sh --docker sudo ./picpeak-setup.sh --docker
``` ```
**Pros:** **Pros:**
@@ -38,7 +38,7 @@ sudo ./setup.sh --docker
Best for: Resource-constrained systems, Raspberry Pi, direct control Best for: Resource-constrained systems, Raspberry Pi, direct control
```bash ```bash
sudo ./setup.sh --native sudo ./picpeak-setup.sh --native
``` ```
**Pros:** **Pros:**
@@ -73,7 +73,7 @@ sudo ./setup.sh --native
### Interactive Mode (Default) ### Interactive Mode (Default)
```bash ```bash
sudo ./setup.sh sudo ./picpeak-setup.sh
``` ```
The script will prompt you to choose: The script will prompt you to choose:
@@ -87,7 +87,7 @@ The script will prompt you to choose:
#### Docker with full configuration: #### Docker with full configuration:
```bash ```bash
sudo ./setup.sh --docker --unattended \ sudo ./picpeak-setup.sh --docker --unattended \
--domain photos.example.com \ --domain photos.example.com \
--email admin@example.com \ --email admin@example.com \
--admin-password SecurePass123 \ --admin-password SecurePass123 \
@@ -100,7 +100,7 @@ sudo ./setup.sh --docker --unattended \
#### Native with minimal configuration: #### Native with minimal configuration:
```bash ```bash
sudo ./setup.sh --native --unattended \ sudo ./picpeak-setup.sh --native --unattended \
--email admin@example.com \ --email admin@example.com \
--admin-password SecurePass123 --admin-password SecurePass123
``` ```
@@ -293,7 +293,7 @@ sudo systemctl restart picpeak-backend picpeak-workers
# Update PicPeak # Update PicPeak
# (reruns migrations to pick up schema fixes for native installs) # (reruns migrations to pick up schema fixes for native installs)
sudo ./setup.sh --update sudo ./picpeak-setup.sh --update
``` ```
## ⚙️ Configuration ## ⚙️ Configuration
@@ -385,14 +385,14 @@ docker compose pull
docker compose up -d docker compose up -d
# Native # Native
sudo ./setup.sh --update sudo ./picpeak-setup.sh --update
``` ```
### Uninstall ### Uninstall
```bash ```bash
# Will prompt for confirmation and data removal options # Will prompt for confirmation and data removal options
sudo ./setup.sh --uninstall sudo ./picpeak-setup.sh --uninstall
``` ```
## 🐛 Troubleshooting ## 🐛 Troubleshooting
@@ -508,13 +508,13 @@ sudo systemctl restart picpeak-backend
### Home/Office Network ### Home/Office Network
```bash ```bash
# Simple local setup without domain # 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 ### Public Website with HTTPS
```bash ```bash
# Full production setup # Full production setup
sudo ./setup.sh --docker \ sudo ./picpeak-setup.sh --docker \
--domain photos.company.com \ --domain photos.company.com \
--email admin@company.com \ --email admin@company.com \
--enable-ssl --enable-ssl
@@ -523,7 +523,7 @@ sudo ./setup.sh --docker \
### Raspberry Pi Setup ### Raspberry Pi Setup
```bash ```bash
# Optimized for ARM devices # Optimized for ARM devices
sudo ./setup.sh --native \ sudo ./picpeak-setup.sh --native \
--port 8080 \ --port 8080 \
--email pi@local.com --email pi@local.com
``` ```
docs/ADMIN_SETUP_GUIDE.md
+1 -1
View File
@@ -109,7 +109,7 @@ If ADMIN_CREDENTIALS.txt is missing:
- File is created in the backend directory root - File is created in the backend directory root
- File might have been deleted for security (as recommended) - 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` - 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 ## Best Practices
scripts/setup.sh → scripts/picpeak-setup.sh
+2 -2
View File
@@ -2,7 +2,7 @@
################################################################################ ################################################################################
# PicPeak Unified Setup Script # PicPeak Unified Setup Script
# Version: 2.0.0 # Version: 2.1.0
# Description: Universal installer for PicPeak with Docker and Native options # Description: Universal installer for PicPeak with Docker and Native options
# Supports: Ubuntu, Debian, Fedora, RHEL/CentOS, Raspberry Pi OS # Supports: Ubuntu, Debian, Fedora, RHEL/CentOS, Raspberry Pi OS
################################################################################ ################################################################################
@@ -11,7 +11,7 @@ set -euo pipefail
IFS=$'\n\t' IFS=$'\n\t'
# Script configuration # Script configuration
readonly SCRIPT_VERSION="2.0.0" readonly SCRIPT_VERSION="2.1.0"
readonly APP_NAME="PicPeak" readonly APP_NAME="PicPeak"
readonly REPO_URL="https://github.com/the-luap/picpeak.git" readonly REPO_URL="https://github.com/the-luap/picpeak.git"
readonly NODE_VERSION="20" readonly NODE_VERSION="20"