Skip to content

Commit 23b3e8a

Browse files
WebRouterclaude
andcommitted
docs: add comprehensive installation & deployment guide
docs/04-installation.md covers all install scenarios: - Fresh install (one-click script, curl pipe, manual) - Updating an existing install (update.sh flow, backup/restore, rollback) - Branch/tag installs via --ref / WR_REF (with auto tag-vs-branch detection) - Service management (start.sh vs start.py, port differences, custom ports) - Docker compose deployment - Directory structure and what update.sh preserves vs updates - .env configuration reference (SQLite/MySQL, ports, Redis, New-API) - Troubleshooting (download fail, missing Go/Python, port conflicts, git pull conflicts, post-update rollback, log locations) - install.sh/update.sh parameter cheat sheet README: link to the new guide from Quick Start, fix default password (admin123 -> admin123456), list 04-installation.md in project tree. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 60e99a7 commit 23b3e8a

2 files changed

Lines changed: 708 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ Don't want to install anything? Try the live demo at **[demo.webrouter.tech](htt
115115

116116
### Install & Run
117117

118+
> 📖 For detailed instructions (branch/tag installs, manual setup, troubleshooting), see **[docs/04-installation.md](docs/04-installation.md)**.
119+
118120
**Linux / macOS:**
119121

120122
```bash
@@ -163,7 +165,7 @@ The script backs up user data, fetches the latest source, rebuilds `wr-proxy`, t
163165

164166
```bash
165167
open http://localhost:5050
166-
# Default login: admin / admin123
168+
# Default login: admin / admin123456
167169
```
168170

169171
### Add Your First Provider
@@ -284,6 +286,10 @@ webrouter/
284286
│ ├── docker-compose.yml
285287
│ └── nginx.conf
286288
├── docs/ # Documentation
289+
│ ├── 01-requirements.md
290+
│ ├── 02-product-plan.md
291+
│ ├── 03-architecture.md
292+
│ └── 04-installation.md # Detailed install/update guide
287293
├── data/ # Runtime data
288294
└── .env # Environment config (auto-generated)
289295
```

0 commit comments

Comments
 (0)