Timmy
9b73c810e6
- Add QUICKSTART.md for 5-minute setup guide - Add SUMMARY.md as project overview - Update README.md with full deployment guide - Update .env.example with better descriptions Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
1.9 KiB
1.9 KiB
CodiMD 快速開始指南
5 分鐘內啟動你的 CodiMD 服務！
前置需求
- Docker
- Docker Compose
三步驟啟動
步驟 1：複製環境設定
cp .env.example .env
步驟 2：啟動服務
docker-compose up -d
等待大約 30 秒讓服務完全啟動。
步驟 3：開始使用
打開瀏覽器訪問：http://localhost:3000
驗證服務狀態
# 查看所有服務
docker-compose ps
# 查看日誌
docker-compose logs -f
正常輸出應該顯示兩個服務都在運行：
NAME STATUS PORTS
codimd-postgres Up (healthy)
codimd-app Up (healthy) 127.0.0.1:3000->3000/tcp
第一次使用
- 點擊「Sign in」登入
- 預設使用「臨時筆記」或註冊新帳號
- 開始創作你的第一個 Markdown 文件！
常用指令
| 操作 | 指令 |
|---|---|
| 查看日誌 | docker-compose logs -f |
| 停止服務 | docker-compose down |
| 重新啟動 | docker-compose restart |
| 更新映像 | docker-compose pull && docker-compose up -d |
資料存放在哪裡？
.
├── pgdata/ # 資料庫資料
└── upload-data/ # 上傳的圖片和檔案
需要更多說明？
查看完整文件：README.md
遇到問題？
# 查看錯誤日誌
docker-compose logs codimd
docker-compose logs database
常見問題：
| 問題 | 解決方案 |
|---|---|
| 無法訪問 3000 port | 等待 30 秒後重新整理 |
| 資料庫連線失敗 | 確認 docker-compose ps 顯示兩個服務都在運行 |
| 忘記密碼 | 編輯 .env 中的 POSTGRES_PASSWORD，然後 docker-compose restart |
下一步
- 生產部署：參考 README.md 的安全建議
- 自訂設定：編輯
.env檔案 - 設定網域：使用 Nginx 或 Caddy 作為反向代理