openclaw/oikos
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add comprehensive installation guide and link from README

Browse Source 
New docs/installation.md covers the full setup journey for Docker
beginners: prerequisites, step-by-step install, .env reference,
Nginx/HTTPS, updates, backup/restore, and troubleshooting.
README Quick Start updated to include clone + .env steps and
links to the detailed guide.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Ulas
2026-04-02 14:54:20 +02:00
parent 789f07100e
commit 28cf388917
2 changed files with 498 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -10
View File
@@ -66,18 +66,15 @@
## Quick Start
```bash
docker compose up -d
```
Then open `http://localhost:3000` and run the setup:
```bash
git clone https://github.com/ulsklyc/oikos.git && cd oikos
cp .env.example .env # then edit .env — set SESSION_SECRET and DB_ENCRYPTION_KEY
docker compose up -d --build
docker compose exec oikos node setup.js
```
Add family members from Settings.
Then open `http://localhost:3000` and log in. Add family members from Settings.
> See [`nginx.conf.example`](nginx.conf.example) for HTTPS and reverse proxy setup.
> **New to Docker?** The **[Installation Guide](docs/installation.md)** walks you through every step — from installing Docker to HTTPS setup, backups, and troubleshooting.
## Tech Stack
@@ -92,8 +89,8 @@ Add family members from Settings.
## Documentation
| 📖 [Spec & Data Model](docs/SPEC.md) | 🤝 [Contributing](CONTRIBUTING.md) | 🔒 [Security](SECURITY.md) | 📋 [Changelog](CHANGELOG.md) | 📌 [Backlog](BACKLOG.md) |
|---|---|---|---|---|
| 🚀 [Installation](docs/installation.md) | 📖 [Spec & Data Model](docs/SPEC.md) | 🤝 [Contributing](CONTRIBUTING.md) | 🔒 [Security](SECURITY.md) | 📋 [Changelog](CHANGELOG.md) | 📌 [Backlog](BACKLOG.md) |
|---|---|---|---|---|---|
## Roadmap