Skip to content

Commit 4b73477

Browse files
committed
fix(docs): make Quick Start step-by-step with .env template and clear instructions
1 parent 792a520 commit 4b73477

1 file changed

Lines changed: 44 additions & 7 deletions

File tree

‎docs/index.md‎

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,54 @@ Source DB ──→ [Batch SELECT with watermark]
8282

8383
## Quick Start
8484

85+
Run Arus in under 2 minutes on any VPS or local machine with Docker.
86+
87+
### 1. Prepare `.env` file
88+
89+
Create an `.env` file next to your `docker-compose.yml`:
90+
91+
```bash
92+
cat > .env << 'EOF'
93+
# REQUIRED — generate with: openssl rand -hex 32
94+
ARUS_JWT_SECRET=your-32-byte-hex-secret-here
95+
ARUS_ENCRYPTION_KEY=your-32-byte-hex-key-here
96+
97+
# Optional overrides (defaults shown)
98+
ARUS_DB_USER=arus
99+
ARUS_DB_PASSWORD=arus_secret
100+
ARUS_DB_NAME=arus_warehouse
101+
ARUS_LOG_LEVEL=INFO
102+
ARUS_BATCH_SIZE=10000
103+
TZ=UTC
104+
EOF
105+
```
106+
107+
> **Generate secure values**: `openssl rand -hex 32` (run it twice — once for `JWT_SECRET`, once for `ENCRYPTION_KEY`).
108+
109+
### 2. Start everything
110+
85111
```bash
86-
# Get the docker-compose.yml from the docs site
87-
# Then start all services
88112
docker compose up -d
113+
```
89114

90-
# Access the console
91-
open http://localhost:8082
115+
### 3. Open the Console
92116

93-
# Default credentials
94-
# Email: admin@arus.io
95-
# Password: admin123
117+
```
118+
http://localhost:8082
119+
```
120+
121+
**Default login:** `admin@arus.io` / `admin123`
122+
123+
---
124+
125+
### Docker Compose file
126+
127+
Download [`docker-compose.yml`](https://raw.githubusercontent.com/edsuwarna/arus/main/docker-compose.yml) or clone the repo:
128+
129+
```bash
130+
git clone https://github.com/edsuwarna/arus.git
131+
cd arus
132+
docker compose up -d
96133
```
97134

98135
---

0 commit comments

Comments
 (0)