Skip to content

docs: clarify service guidance for CLI, TUI, and self-managed flows #1108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stablegenius49 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify service guidance for CLI, TUI, and self-managed flows #1108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs/_partial-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,6 @@ If you enter <kbd>Y</kbd>, provide the following Langfuse credentials:

8. If the OpenRAG app doesn't launch automatically, select the **Open OpenRAG in browser** option to launch the OpenRAG app and start the [application onboarding process](#application-onboarding).
You can also manually navigate to `localhost:3000` in a browser.
For a side-by-side guide to the CLI wizard, the GUI TUI (`--tui`), and self-managed service controls, see [Manage OpenRAG containers and services](/manage-services).

If you provided Google OAuth credentials, you must sign in with Google before you are redirected to your OpenRAG instance.
61 changes: 52 additions & 9 deletions docs/docs/get-started/manage-services.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,29 @@ If you [installed OpenRAG](/install-options) with `uv` or `uvx`, then you can us

For [self-managed deployments](/docker), run Docker or Podman commands to manage your OpenRAG services.

OpenRAG provides three service-management paths:

* **CLI wizard** (`uv run openrag` or `uvx openrag`): Guided terminal session with deployment-wide **Start services**, **Stop services**, **Show status**, and **Open OpenRAG in browser** options.
* **GUI TUI** (`uv run openrag --tui` or `uvx openrag --tui`): Terminal UI with clickable **Status** views, streaming logs, and per-service controls.
* **Self-managed services**: Direct Docker or Podman orchestration for container services, plus host-level management for native services like Docling.

## Monitor services and view logs

<Tabs>
<TabItem value="TUI" label="Terminal-managed services" default>
<TabItem value="cli" label="CLI wizard" default>

In the terminal session, select the **Show status** option to access information about all OpenRAG services, including container health, ports, and image versions.

For more information and options, you must [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.
Then, click **Status** to access controls to stop, start, or restart individual services.
The CLI wizard shows deployment-wide status and controls.
If you need clickable per-service controls or streaming logs, [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.

For the Docling native service, see [Stop, start, and inspect native services](#start-native-services).

</TabItem>
<TabItem value="tui" label="GUI TUI (`--tui`)">

[Start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`, and then click **Status** to access information about all OpenRAG services, including container health, ports, image versions, and per-service controls.

To view streaming logs, click the name of a service, and then press <kbd>l</kbd>.

For the Docling native service, see [Stop, start, and inspect native services](#start-native-services).
Expand All @@ -46,11 +60,11 @@ For the Docling native service, see [Stop, start, and inspect native services](#
## Stop and start containers

<Tabs>
<TabItem value="TUI" label="Terminal-managed services" default>
<TabItem value="cli" label="CLI wizard" default>

In the terminal session, use the **Start services** and **Stop services** options to start or stop all OpenRAG services.

For fine-grained controls, you must [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.
For fine-grained controls, [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.
Then, click **Status** to access controls to stop, start, or restart individual services.

:::tip
Expand Down Expand Up @@ -78,6 +92,16 @@ Typically, this is only necessary if you don't want to use `--tui` or there is a
* Stop one container: `docker stop CONTAINER_ID` or `podman stop CONTAINER_ID`
* Start one container: `docker start CONTAINER_ID` or `podman start CONTAINER_ID`

</TabItem>
<TabItem value="tui" label="GUI TUI (`--tui`)">

The GUI TUI provides the same deployment-wide **Start services** and **Stop services** controls as the CLI wizard.
For per-service controls, [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`, and then click **Status** to stop, start, or restart individual services.

:::tip
<PartialContainerVm />
:::

</TabItem>
<TabItem value="env" label="Self-managed services">

Expand All @@ -96,13 +120,18 @@ For self-managed deployments, run the Docker/Podman commands to stop and start c
A _native service_ in OpenRAG is a service that runs locally on your machine, not within a container. For example, the `docling serve` process is an OpenRAG native service because this document processing service runs on your local machine, separate from the OpenRAG containers.

<Tabs>
<TabItem value="TUI" label="Terminal-managed services" default>
<TabItem value="cli" label="CLI wizard" default>

In the terminal session, select the **Show status** option to view the status, port, and process ID (PID) for OpenRAG's native services.
Native services are started and stopped when you use the **Start services** and **Stop services** options.

For more information and options, you must [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.
Then, click **Status** to access controls to stop, start, or restart individual services.
If you need clickable per-service controls or streaming logs, [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.

</TabItem>
<TabItem value="tui" label="GUI TUI (`--tui`)">

[Start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`, and then click **Status** to view the status, port, and process ID (PID) for OpenRAG's native services.
Use the **Status** view to stop, start, or restart individual services.
To view streaming logs, click the name of a service, and then press <kbd>l</kbd>.

</TabItem>
Expand Down Expand Up @@ -156,7 +185,21 @@ Your documents are reingested into a fresh OpenSearch index after the reset.
To reset your OpenRAG deployment _and_ delete all OpenRAG data, see [Reinstall OpenRAG](/reinstall).

<Tabs>
<TabItem value="TUI" label="Terminal-managed services" default>
<TabItem value="cli" label="CLI wizard" default>

<PartialExportFlows />

2. Factory reset isn't available from the CLI wizard alone.
To destroy and recreate your OpenRAG containers, [start the terminal session with `--tui`](/tui#access-the-tui), such as `uv run openrag --tui`.

3. Click **Status** in the [TUI](/tui), and then click **Factory Reset**.

4. Repeat the [setup process](/install-uvx#setup) to restart the services and launch the OpenRAG app. Your previous configuration, including credentials, are restored from the `.env` file.

5. If you exported customized flows, [import your flows](https://docs.langflow.org/concepts-flows-import) into Langflow after completing the onboarding process.

</TabItem>
<TabItem value="tui" label="GUI TUI (`--tui`)">

<PartialExportFlows />

Expand Down
Loading