aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: eb8ef209a0db0052974d729b0ac73667ab12acaf (plain)
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
# newOS4

A browser terminal: a filesystem, a command shell, an editor and a tool-calling AI agent that all live
in one page, backed by a WebDAV space.

## Status and scope

newOS4 is the terminal that runs **WebX11** user spaces (`https://webx11.duckdns.org/spaces/newos4/`).
It is published here so the code can be read, audited and studied — it is **not** a packaged product:
it expects a WebX11 host to provide

* WebDAV storage at `/spaces/<user>/` (nginx + `dav-auth-check`),
* the session API at `/api/auth/*`,
* the metered AI gateway at `/ollama/*` (`webx11-aigateway`).

Several defaults still point at the author's host (`https://webx11.duckdns.org`); a self-hosted
deployment must change them (grep `webx11.duckdns.org`).

## Getting the code

```bash
git clone https://newos.webx11.duckdns.org/newos4.git
```

Per-OS setup (Linux, macOS, Windows, **Android/Termux**, iOS): <https://newos.webx11.duckdns.org/usage.html>

Read-only mirror: no account, no push. A running instance lives on the WebX11 platform at
`https://webx11.duckdns.org/spaces/newos4/` (login required). History is preserved and sanitised —
a few paths that existed in the source tree (`backups/`, `data/`, personal profiles) are absent by design.

## Layout

| Path | What |
|---|---|
| `main.html` | the page; loads `modules/core/core-bundle.js` |
| `modules/core/` | terminal, filesystem, AI assist, orchestrator, model profiles |
| `modules/ext/` | individually loaded extensions (webdav, alias, busybox, course, …) |
| `api/chat/` | the chat bridge endpoints (PHP, token-scoped) |
| `api/debug/` | health/report/feedback endpoints |
| `scripts/` | maintenance and triage tools |
| `course/`, `help.html`, `cheatsheet.html` | built-in documentation |
| `CHANGELOG.md` | every shipped fix, symptom → cause → fix → verified |

## Version

See `CHANGELOG.md`; the loader version is `vX.Y.Z` in `main.html` and `modules/module-loader.js`.

## Licence

MIT — see `LICENSE`.