tty-web 0.16.4

Web-based terminal emulator — opens a real PTY in the browser over WebSocket
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

//! HTTP and WebSocket server built on [Axum](https://docs.rs/axum).
//!
//! Routes:
//! - `GET /ws` — WebSocket endpoint (terminal I/O)
//! - `GET /api/v1/ping` — health check
//! - `GET /` and `GET /*path` — embedded static frontend

pub mod health;
pub mod static_files;
pub mod ws;

use std::path::PathBuf;
use std::sync::Arc;

use axum::Router;
use axum::routing::get;

use crate::session::SessionStore;

/// Shared state passed to all request handlers.
#[derive(Clone)]
#[non_exhaustive]
pub struct AppState {
    /// Shell binary path (e.g. `/bin/bash`).
    pub shell: String,
    /// Working directory for new shell sessions.
    pub pwd: Option<PathBuf>,
    /// Scrollback buffer size in bytes.
    pub scrollback_limit: usize,
    /// Global session registry.
    pub sessions: Arc<SessionStore>,
    /// Time without clients before a session is reaped.
    pub orphan_timeout: std::time::Duration,
}

/// Build the Axum router with all routes and shared state.
pub fn router(
    shell: String,
    pwd: Option<PathBuf>,
    scrollback_limit: usize,
    sessions: Arc<SessionStore>,
    orphan_timeout: std::time::Duration,
) -> Router {
    let state = AppState {
        shell,
        pwd,
        scrollback_limit,
        sessions,
        orphan_timeout,
    };
    Router::new()
        .route("/ws", get(ws::ws_handler))
        .route("/api/v1/ping", get(health::ping))
        .route("/", get(static_files::index))
        .route("/{*path}", get(static_files::static_file))
        .with_state(state)
}