gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

tui-more-information

Browse source
This commit is contained in:
Mendon Kissling 2025-09-29 21:24:18 -04:00
parent 70a1d0b19e
commit 4de9a1fe93
1 changed files with 33 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
docs/docs/get-started/tui.mdx
View file

@ -27,6 +27,17 @@ uv run openrag
The TUI Welcome Screen offers basic and advanced setup options. The TUI Welcome Screen offers basic and advanced setup options.
For more information on setup values during installation, see [Install OpenRAG](/install). For more information on setup values during installation, see [Install OpenRAG](/install).
## Navigation
The TUI accepts mouse input or keyboard commands.
- <kbd>Arrow keys</kbd>: move between options
- <kbd>Tab</kbd>/<kbd>Shift+Tab</kbd>: switch fields and buttons
- <kbd>Enter</kbd>: select/confirm
- <kbd>Escape</kbd>: back
- <kbd>Q</kbd>: quit
- <kbd>Number keys (1-4)</kbd>: quick access to main screens
## Container management ## Container management
The TUI can deploy, manage, and upgrade your OpenRAG containers. The TUI can deploy, manage, and upgrade your OpenRAG containers.
@ -52,47 +63,32 @@ To view the status, port, or PID of a native service, in the TUI main menu, clic
### Status ### Status
The **Status** screen The **Status** menu displays information on your container deployment.
Here you can check container health, find your service ports, view logs, and upgrade your containers.
### Diagnostics To view streaming logs, select the container you want to view, and press <kbd>l</kbd>.
To copy your logs, click **Copy to Clipboard**.
### Welcome Screen To **upgrade** your containers, click **Upgrade**.
- Quick setup options: basic (no auth) or advanced (OAuth) **Upgrade** runs `docker compose pull` and then `docker compose up -d --force-recreate`.
- Service monitoring: container status at a glance The first command pulls the latest images of OpenRAG.
- Quick actions: diagnostics, logs, configuration The second command recreates the containers with your data persisted.
### Configuration Screen To **reset** your containers, click **Reset**.
- Environment variables: guided forms for required settings Reset gives you a completely fresh start.
- API keys: secure input with validation Reset deletes all of your data, including OpenSearch data, uploaded documents, and authentication.
- OAuth setup: Google and Microsoft **Reset** runs two commands.
- Document paths: configure ingestion directories It first stops and removes all containers, volumes, and local images.
- Auto-save: generates and updates `.env` ```
docker compose down --volumes --remove-orphans --rmi local
```
### Service Monitor When the first command is complete, OpenRAG removes any additional Docker objects with `prune`.
- Container status: real-time state of services
- Resource usage: CPU, memory, network
- Service control: start/stop/restart
- Health checks: health indicators for all components
### Log Viewer
- Live logs: stream logs across services
- Filtering: by service (backend, frontend, Langflow, OpenSearch)
- Levels: DEBUG/INFO/WARNING/ERROR
- Export: save logs for later analysis
### Diagnostics
- System checks: Docker/Podman availability and configuration
- Environment validation: verify required variables
- Network tests: connectivity between services
- Performance metrics: system capacity and recommendations
## Navigation
- Arrow keys: move between options
- Tab/Shift+Tab: switch fields and buttons
- Enter: select/confirm
- Escape: back
- Q: quit
- Number keys (1-4): quick access to main screens
```
docker system prune -f
```
## Diagnostics
The **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security.