Skip to content

Commit

Permalink
docs: updated server docs with better structure and mention of gptme-…
Browse files Browse the repository at this point in the history
…webui
  • Loading branch information
ErikBjare committed Nov 5, 2024
1 parent 7b62201 commit c32f64d
Showing 1 changed file with 44 additions and 30 deletions.
74 changes: 44 additions & 30 deletions docs/server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,52 +13,66 @@ It can be started by running the following command:
gptme-server
For more CLI usage, see :ref:`the CLI documentation <cli:gptme-server>`.

There are a few different interfaces available:

Web UI
------

The server provides two interfaces:
A basic chat interface with minimal dependencies that is bundled with the server.

Simply start the server to access the interface at http://localhost:5000

Fancy Web UI
------------

1. Basic Chat Interface
A modern, feature-rich web interface for gptme is available as a separate project `gptme-webui <https://github.com/ErikBjare/gptme-webui>`_. It is mainly built with `gptengineer.app <https://gptengineer.app>`_.

.. code-block:: bash
To use gptme-webui, see the `gptme-webui README <https://github.com/ErikBjare/gptme-webui>`_.

gptme-server
Features:

Access the basic chat interface at http://localhost:5000
- Modern React-based interface with shadcn/ui
- Streaming of responses
- Mobile-friendly design
- Dark mode support
- Offline/exports support

For more usage, see :ref:`the CLI documentation <cli:gptme-server>`.

2. Computer Use Interface
Computer Use Interface
----------------------

Requires Docker.
.. include:: computer-use-warning.rst

The computer use interface provides a split view with a chat on the left and a desktop on the right.

.. code-block:: bash
Requires Docker.

# Clone the repository
git clone https://github.com/ErikBjare/gptme.git
cd gptme
# Build container
make build-docker-computer
# Run container
docker run -v ~/.config/gptme:/home/computeruse/.config/gptme -p 6080:6080 -p 8080:8080 gptme-computer:latest
.. code-block:: bash
The computer use interface provides:
# Clone the repository
git clone https://github.com/ErikBjare/gptme.git
cd gptme
# Build container
make build-docker-computer
# Run container
docker run -v ~/.config/gptme:/home/computeruse/.config/gptme -p 6080:6080 -p 8080:8080 gptme-computer:latest
- Combined view at http://localhost:8080/computer
- Chat view at http://localhost:8080
- Desktop view at http://localhost:6080/vnc.html
The computer use interface provides:

Features:
- Combined view at http://localhost:8080/computer
- Chat view at http://localhost:8080
- Desktop view at http://localhost:6080/vnc.html

- Split view with chat on the left, desktop on the right
- Toggle for view-only/interactive desktop mode
- Fullscreen support
- Automatic screen scaling for optimal LLM vision
Features:

Requirements:
- Split view with chat on the left, desktop on the right
- Toggle for view-only/interactive desktop mode
- Fullscreen support
- Automatic screen scaling for optimal LLM vision

- Docker for running the server with X11 support
- Browser with WebSocket support for VNC
- Network ports 6080 (VNC) and 8080 (web UI) available
Requirements:

.. include:: computer-use-warning.rst
- Docker for running the server with X11 support
- Network ports 6080 (VNC) and 8080 (web UI) available

0 comments on commit c32f64d

Please sign in to comment.