Updated readme
This commit is contained in:
@@ -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
|
||||||
Reference in New Issue
Block a user