How openatx/atxserver2 works
Main Components
a. Frontend (Client)
• Web browser or any HTTP client
• Loads HTML templates (templates/*.html) and static assets (static/javascripts, static/images)
b. Backend Web Server (Monolith)
• Entry point: main.py → starts a Tornado HTTP server
• Web layer: web/entry.py, web/urls.py, web/views/…
• Utilities: web/utils.py, web/libs/jsondate.py
• Settings & version: web/settings.py, web/__version__.py, web/version.py
• Database access: web/database.py (RethinkDB driver)
c. Persistence
• RethinkDB cluster (configured via environment variables or settings.py)
d. Authentication Providers (External Services)
• OpenID
• GitHub OAuth
e. Device Providers (Sidecar Services / Microservices)
• atxserver2‑android‑provider (Docker container)
• atxserver2‑ios‑provider (similar)
• Optional scripts/dummies for testing (scripts/fake_*.py, scripts/dummyslave.py)
f. Deployment & Orchestration
• Dockerfile + docker-compose.yml
• Procfile for Heroku-like platforms
• Shell scripts: wait-for-db.sh, wait_for_rethinkdb.py
Relationships & Data Flows
• Browser → Tornado Server: HTTP(S) requests for pages, AJAX, REST API calls
• Tornado Server → RethinkDB: CRUD queries (async)
• Tornado Server → Auth Providers: outbound OAuth/OpenID requests
• Device Providers ↔ Tornado Server:
• Providers register themselves or poll for tasks via RESTful endpoints (defined in web/views/provider.py)
• Providers stream device snapshots or input events back to server (multipart_streamer.py)
• Browser → Device Providers (indirect): via server‑mediated websockets or long polling to view/control device screens
• Admin API & CLI examples invoked via API.md
Architectural Patterns
• MVC‑style separation:
• Views: web/views/*
• Templates: templates/*.html
• Static assets: static/*
• Async I/O: Tornado’s non‑blocking handlers (async/await)
• Micro‑service / side‑car pattern: external device providers decoupled from core server
• Configuration via environment variables & settings.py
• Containerization for reproducible builds (Docker/Docker‑compose)