# Welcome to NØXTERM

***

**Privacy-First Web Terminal with Isolated Container Execution**

NOXTERM is a web-based terminal that executes commands in completely isolated Docker containers. Each session runs in an ephemeral environment that is destroyed the moment you disconnect—leaving no traces behind.

<figure><img src="https://3552540895-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHcGoi6yLMUd8PrdEa0au%2Fuploads%2Fybem7RVMq1r6HFPiMEBh%2FBildschirmfoto%202025-12-18%20um%201.42.22%E2%80%AFPM.png?alt=media&#x26;token=acdfede5-9752-44cf-8e59-f88b74cbd96e" alt=""><figcaption></figcaption></figure>

***

### Documentation

| Section         | Description                               |
| --------------- | ----------------------------------------- |
| Overview        | System introduction and design philosophy |
| Getting Started | Installation and first session            |
| Architecture    | Technical architecture and data flows     |
| Configuration   | Environment variables and customization   |
| API Reference   | REST and WebSocket API documentation      |
| Security        | Security features and best practices      |
| Privacy Mode    | Anyone Protocol integration               |

***

### Quick Start

```bash
# Clone and build
git clone https://github.com/NON-OS/noxterm.git
cd noxterm

# Start backend
cd nox-backend && cargo run --release
SERVER_PORT=3001 cargo run --bin noxterm-backend

# Start frontend (new terminal)
cd frontend && npm install && npm run dev
```

Open `http://localhost:5173` to access the terminal.

***

### Features

* Full PTY support with interactive applications (vim, nano, htop)
* Multiple container environments (Ubuntu, Alpine, Debian, Node.js, Python, Rust)
* WebSocket-based real-time terminal communication
* Optional anonymous network routing via Anyone Protocol
* Container resource limits and automatic cleanup
* Audit logging and security validation
* Cross-platform support (macOS, Linux, Windows)

***

### Technology Stack

| Component  | Technology                       |
| ---------- | -------------------------------- |
| Backend    | Rust + Axum + Tokio              |
| Frontend   | React 18 + TypeScript + xterm.js |
| Containers | Docker with Bollard API          |
| Database   | PostgreSQL (optional)            |
| Privacy    | Anyone Protocol (SOCKS5)         |

***

### Links

* [GitHub Repository](https://github.com/NON-OS/noxterm)
* [NONOS Documentation](https://docs.nonos.systems)
* [Report Issues](https://github.com/NON-OS/noxterm/issues)