Files

geoffsee eed180fdf2 Rename project to "open-web-agent-rs" across all files

Updated project name from "web-agent-rs" to "open-web-agent-rs" in configuration files, documentation, and source code. This change ensures consistency across the project and reflects the new naming convention. Removed unused entries from `.gitignore` and adjusted Docker commands accordingly.

2025-05-27 15:23:07 -04:00

1.6 KiB

Raw Blame History

Installation Guide

Prerequisites

Before installing open-open-web-agent-rs, ensure you have the following prerequisites:

Rust (latest stable version)
Node.js (for GenAIScript)
Bun (for package management)
Docker (optional, for containerized deployment)

Environment Setup

Clone the repository:

git clone https://github.com/seemueller-io/open-web-agent-rs.git
cd open-web-agent-rs

Create a .env file in the root directory with the following variables:

OPENAI_API_KEY=your_openai_api_key
BING_SEARCH_API_KEY=your_bing_search_api_key
TAVILY_API_KEY=your_tavily_api_key
GENAISCRIPT_MODEL_LARGE=gpt-4-turbo
GENAISCRIPT_MODEL_SMALL=gpt-3.5-turbo
SEARXNG_API_BASE_URL=your_searxng_url

Local Development

Install Rust dependencies:
```
cargo build
```
Install JavaScript dependencies:
```
bun install
```
Run the server:
```
cargo run
```
The server will start on http://localhost:3006.

Docker Deployment

You can also run the application using Docker:

Build the Docker image:

docker build -t open-web-agent-rs -f <Local|Remote>.Dockerfile .

Run the container:

docker run -p 3006:3006 --env-file .env open-web-agent-rs

Alternatively, you can use Docker Compose:

docker-compose up

Configuration Options

The application can be configured using environment variables. See the Configuration documentation for more details.

1.6 KiB Raw Blame History