From c7333651dfa0363a3632e4eb7f656b197e324a83 Mon Sep 17 00:00:00 2001 From: nmemmert Date: Tue, 13 Jan 2026 15:55:05 -0500 Subject: [PATCH] Update installation docs for private repository - Added clone and deploy method as primary option - Noted that curl install only works for public repos - Updated README.md with both installation methods - Updated DEPLOYMENT.md with proper instructions - Clone method works for both private and public repos --- DEPLOYMENT.md | 34 ++++++++++++++++++++-------------- README.md | 19 ++++++++++--------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index 1fa8a34..700ad02 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -1,27 +1,33 @@ # Capsule Budget - ZimaOS Deployment Guide -## One-Line Installation (Easiest) +## Installation Methods -Run this single command on your ZimaOS device: +### Method 1: Clone and Deploy (Recommended for Private Repos) + +If the repository is private, clone it first: + +```bash +# Clone the repository +git clone https://github.com/nmemmert/budget.git capsule-budget +cd capsule-budget + +# Run the deploy script +./deploy.sh +``` + +**Access at:** `http://your-zima-ip:7654` + +### Method 2: One-Line Installation (Public Repos Only) + +If the repository is public: ```bash curl -fsSL https://raw.githubusercontent.com/nmemmert/budget/master/install.sh | bash ``` -**What it does:** -1. ✅ Checks for Docker and Docker Compose -2. ✅ Downloads Capsule Budget -3. ✅ Generates secure encryption key -4. ✅ Creates data directory -5. ✅ Builds Docker image -6. ✅ Starts the container -7. ✅ Shows access URLs - -**Then access at:** `http://your-zima-ip:7654` - --- -## Quick Deploy +## Quick Deploy (Manual) 1. **Clone or upload this repository to your ZimaOS device** diff --git a/README.md b/README.md index afe59f8..c5ec1a6 100644 --- a/README.md +++ b/README.md @@ -59,21 +59,22 @@ A modern, privacy-focused envelope budgeting application built with Next.js, Typ ## Getting Started -### One-Line Installation (Docker - Recommended) +### Docker Installation (Recommended for ZimaOS) -For ZimaOS or any system with Docker: +**Option 1: Clone and Deploy** (works for private/public repos) + +```bash +git clone https://github.com/nmemmert/budget.git capsule-budget +cd capsule-budget +./deploy.sh +``` + +**Option 2: One-Line Install** (public repos only) ```bash curl -fsSL https://raw.githubusercontent.com/nmemmert/budget/master/install.sh | bash ``` -This will automatically: -- Check for Docker and Docker Compose -- Download Capsule Budget -- Generate a secure encryption key -- Build and start the container -- Set up data persistence - **Access at:** `http://localhost:7654` or `http://your-device-ip:7654` ### Manual Installation (Development)