Files
The-transit-Project/monitoring_ui/docs/DOMAINS_README.md
T
Sven laptop 635a130f0b
Build and Push Docker Images / detect-changes (push) Successful in 11s
Build and Push Docker Images / build-auth-api (push) Successful in 1m0s
Build and Push Docker Images / build-employee-api (push) Successful in 1m2s
Build and Push Docker Images / build-transit-api (push) Successful in 1m1s
Build and Push Docker Images / build-error-log-api (push) Successful in 1m5s
Build and Push Docker Images / build-admin-ui (push) Successful in 1m13s
Build and Push Docker Images / build-monitoring-ui (push) Successful in 1m15s
Build and Push Docker Images / deploy-test-node (push) Successful in 3s
──────
### Summary of Changes
  1. Documentation Consolidation:
      • Relocated the docs/ folder and all repository .md files (README.md, DEPLOYMENT.md, DOCKER_README.md,
      DOMAINS_README.md, GETTING_STARTED.md, CI_CD_PORTAINER_GUIDE.md, ADMIN_DEPLOYMENT_SUMMARY.md,
      SECURITY_PRIVATE_FILES.md, handoff.md, azure-project-plan.md, plus service-specific READMEs) into .
      • Updated document links in README.md.
  2. AI Agent Project Map:
      • Created PROJECT_MAP.md in the project root containing complete architecture diagrams, service specs, ports, DB
      schemas, environment variables, and developer workflows.
      • Added PROJECT_MAP.md to .gitignore.
  3. Monitoring UI & Infrastructure Integration:
      • Added monitoring_ui service to docker-compose.yml (port 5175).
      • Configured Gitea workflow docker-build.yml for monitoring_ui builds.
      • Added CORS middleware headers in index.js.
      • Added nginx.conf copy step in Dockerfile.

  ──────
  ### Recommended Commit Message

    docs: consolidate project documentation into monitoring_ui and add agent project map

    - Move all markdown documentation files and docs/ folder into monitoring_ui/docs/
    - Update documentation hub index (monitoring_ui/docs/README.md) with relative paths
    - Generate comprehensive AI agent reference map (PROJECT_MAP.md) in repository root
    - Add PROJECT_MAP.md and monitoring_ui build output/env overrides to .gitignore
    - Integrate monitoring_ui service into docker-compose.yml and Gitea CI workflow
    - Configure CORS handling in employee_api for monitoring dashboard access
    ──────
  ### Alternative Short Commit Message

    refactor(docs): move docs to monitoring_ui and create AI agent PROJECT_MAP.md
2026-09-20 23:33:55 +02:00

56 lines
3.3 KiB
Markdown

# XTransit Domains
This document is the central reference for the public XTransit hostnames.
Use HTTPS for every public request.
## Public Domains
| Domain | Service | Purpose |
| -------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `https://auth.xtransit.testinstance.nl` | Auth API | Driver and administrator login. Issues and validates JWT authentication tokens. Use this domain only for authentication requests such as `POST /login`. |
| `https://employees.xtransit.testinstance.nl` | Employee API | Employee onboarding and employee management. |
| `https://transit.xtransit.testinstance.nl` | Transit API | Transit and schedule data used by the Windows XP driver client, admin UI, and public timetable clients. This includes assigned daily schedules, weekly templates, shifts, bus lines, stops, routes, and timetable views. |
| `https://error.xtransit.testinstance.nl` | Error Log API | Central error collection and administration. Services send errors to `POST /error_log`; administrators can inspect them through `GET /error_log`. |
| `https://admin.xtransit.testinstance.nl` | Admin panel | Browser-based administration interface for managing bus lines, stops, vehicles, weekly schedules, driver shifts, and error logs. |
## Client Rules
### Windows XP driver client
The XP client must use:
- Auth and login: `https://auth.xtransit.testinstance.nl`
- Assigned schedules and route stops: `https://transit.xtransit.testinstance.nl`
The XP client must never use the auth domain for transit data.
### Admin UI and public timetable
The admin panel is available at `https://admin.xtransit.testinstance.nl`.
The admin UI and public timetable use:
- Authentication: `https://auth.xtransit.testinstance.nl`
- Transit API: `https://transit.xtransit.testinstance.nl`
- Error logging: `https://error.xtransit.testinstance.nl`
### Backend services
The backend services report errors to:
```text
https://error.xtransit.testinstance.nl/error_log
```
The database and internal Docker service name are deployment details and should not
be exposed as public client URLs. Public clients must use the HTTPS domains above.
## Quick Reference
```text
auth.xtransit.testinstance.nl Authentication and JWT tokens
employees.xtransit.testinstance.nl Employee management
transit.xtransit.testinstance.nl All transit and schedule data
error.xtransit.testinstance.nl Central error logging
admin.xtransit.testinstance.nl Browser-based administration panel
```