Upload README.md with huggingface_hub

README.md

@@ -1,49 +1,45 @@
 ---
 title: Hue Portal Backend
-emoji: ⚖️
+affiliation: Cong An Thanh Pho Hue
 colorFrom: green
 colorTo: blue
 sdk: docker
-sdk_version: "0.0.1"
-app_file: app.py
 pinned: false
 license: apache-2.0
 ---
 
-## Authentication & Authorization
+## Deployment Notes
 
-### Seed tài khoản mặc định
+This Space packages the Django backend (OCR + RAG stack) from the `TryHarDemNayProject` repo. It installs the full backend inside the container and exposes the API on port **7860** via Gunicorn.
 
-Sau khi thiết lập môi trường:
+### Environment variables required
 
-```bash
-cd backend/hue_portal
-source ../venv/bin/activate
-python manage.py migrate
-python manage.py seed_default_users
-```
-
-Các biến môi trường hỗ trợ tuỳ biến (tùy chọn):
+Set the following secrets in **Settings → Repository secrets** before building the Space:
 
-| Biến | Mặc định |
-|------|----------|
-| `DEFAULT_ADMIN_USERNAME` | `admin` |
-| `DEFAULT_ADMIN_EMAIL` | `admin@example.com` |
-| `DEFAULT_ADMIN_PASSWORD` | `Admin@123` |
-| `DEFAULT_USER_USERNAME` | `user` |
-| `DEFAULT_USER_EMAIL` | `[email protected]` |
-| `DEFAULT_USER_PASSWORD` | `User@123` |
+| Variable | Description |
+|----------|-------------|
+| `DATABASE_URL` | PostgreSQL connection string (Railway instance) with `?sslmode=require`. |
+| `DJANGO_SECRET_KEY` | Secret key for Django. |
+| `DJANGO_ALLOWED_HOSTS` | e.g. `*.hf.space,localhost`. |
+| `DEFAULT_LLM_PROVIDER`, `LLM_PROVIDER`, etc. | Optional overrides reused from the original `.env`. |
 
-### API đăng nhập
+You can push these secrets via the helper script:
 
-- `POST /api/auth/login/` – body `{ "username": "...", "password": "..." }`
-- `POST /api/auth/logout/` – body `{ "refresh": "<refresh_token>" }` (header `Authorization: Bearer <access>`)
-- `GET /api/auth/me/` – lấy thông tin user hiện tại
-- `POST /api/auth/register/` – chỉ admin gọi được; truyền thêm `role` (`admin` hoặc `user`) khi tạo tài khoản mới.
+```bash
+cp ops/hf.secrets.env.example ops/hf.secrets.env
+# edit ops/hf.secrets.env with real values
+export HF_TOKEN=hf_xxx  # token with write access to the Space
+python backend/scripts/update_hf_space_secrets.py \
+    --space davidttran999/hue-portal-backendDocker \
+    --secrets-file ops/hf.secrets.env
+```
 
-### Phân quyền
+### Startup process
 
-- Upload tài liệu (`/api/legal-documents/upload/`) yêu cầu user role `admin` hoặc cung cấp header `X-Upload-Token`.
-- Frontend hiển thị nút “Đăng nhập” ở trang chủ và trên thanh điều hướng. Khi đăng nhập thành công sẽ hiển thị tên + role, kèm nút “Đăng xuất”.
+`entrypoint.sh` automatically runs:
 
+1. `python hue_portal/manage.py migrate`
+2. `python hue_portal/manage.py createcachetable`
+3. `gunicorn hue_portal.hue_portal.wsgi:application --bind 0.0.0.0:7860`
 
+Logs are streamed in the Space console. If migrations fail because the DB already contains the schema, re-run after fixing credentials or drop the DB manually.