Updated readme

This commit is contained in:
mvbingham
2025-12-14 21:09:47 -05:00
parent 178c3205db
commit 48977a1871

View File

@@ -33,24 +33,16 @@ Homebox is a **home inventory management system** built for the Home User. It he
## 🚀 Quick Start ## 🚀 Quick Start
### Step 1⃣: Configure Environment ### Step 1⃣: Create docker-compose.yml
```bash ```bash
cd services/homebox touch docker-compose.yml
cp .env.example .env
# Edit .env with your settings
``` ```
> 💡 **Tip**: You can disable registration after creating your account by setting `HBOX_OPTIONS_ALLOW_REGISTRATION=false`
### Step 2⃣: Start Service ### Step 2⃣: Start Service
```bash ```bash
# From services/homebox directory # homebox directory
docker-compose up -d docker-compose up -d
# Or from repository root
docker-compose -f services/homebox/docker-compose.yml up -d
``` ```
### Step 3⃣: Access Homebox ### Step 3⃣: Access Homebox