Improve README deployment script documentation

- Add clear reference to local deployment script as recommended option
- Document contents of scripts/ directory at the start of deployment section
- Clarify that deploy.sh automates the entire setup process
- Make it easier for users to find and use the local deployment script

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude Code 2025-07-07 11:44:39 -04:00
parent e0eeb1e944
commit 1cf3a09e20

View file

@ -111,6 +111,14 @@ PORT=3000
## Deployment
### Deployment Scripts
The `scripts/` directory contains all deployment-related files:
- `deploy.sh` - Automated deployment script for Debian 12 (ARM64/x86_64)
- `icewatch.service` - Systemd service file for the application
- `Caddyfile` - Caddy reverse proxy configuration
- `generate-icons.js` - Script to generate PWA icons
### Quick Deployment (Recommended)
See `docs/deployment-quickstart.md` for a simplified deployment guide.
@ -118,6 +126,18 @@ See `docs/deployment-quickstart.md` for a simplified deployment guide.
### Automated Deployment (Debian 12 ARM64/x86_64)
1. **Run the deployment script on your server:**
**Option A: Use the local deployment script (Recommended)**
```bash
# Clone the repository first
git clone https://git.deco.sh/deco/ice.git
cd ice
# Run the local deployment script
sudo bash scripts/deploy.sh
```
**Option B: Download from S3**
```bash
# Default: Downloads config from S3
curl -sSL https://ice-puremichigan-lol.s3.amazonaws.com/scripts/deploy.sh | bash
@ -125,6 +145,12 @@ See `docs/deployment-quickstart.md` for a simplified deployment guide.
# Alternative: Use local files only (no S3)
curl -sSL https://ice-puremichigan-lol.s3.amazonaws.com/scripts/deploy.sh | S3_BUCKET_NAME=none bash
```
The deployment script (`scripts/deploy.sh`) automates the entire setup process including:
- Installing required dependencies (Node.js, Git, Caddy)
- Creating system user and directories
- Setting up systemd services
- Configuring Caddy reverse proxy
2. **Deploy your application:**
```bash