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.
This commit is contained in:
geoffsee
@@ -2,7 +2,7 @@
|
||||
|
||||
## Environment Variables
|
||||
|
||||
web-agent-rs uses environment variables for configuration. These can be set in a `.env` file in the root directory or directly in your environment.
|
||||
open-web-agent-rs uses environment variables for configuration. These can be set in a `.env` file in the root directory or directly in your environment.
|
||||
|
||||
### Required Environment Variables
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# web-agent-rs Documentation
|
||||
# open-web-agent-rs Documentation
|
||||
|
||||
Welcome to the documentation for web-agent-rs, a GenAIScript host for integration into conversational AI applications.
|
||||
Welcome to the documentation for open-web-agent-rs, a GenAIScript host for integration into conversational AI applications.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -12,7 +12,7 @@ Welcome to the documentation for web-agent-rs, a GenAIScript host for integratio
|
||||
|
||||
## Overview
|
||||
|
||||
web-agent-rs is a server that hosts GenAIScript agents for integration into conversational AI applications. It provides a simple API for creating and consuming stream resources that execute various agents to perform tasks like web search, news search, image generation, and web scraping.
|
||||
open-web-agent-rs is a server that hosts GenAIScript agents for integration into conversational AI applications. It provides a simple API for creating and consuming stream resources that execute various agents to perform tasks like web search, news search, image generation, and web scraping.
|
||||
|
||||
## Architecture
|
||||
|
||||
@@ -28,7 +28,7 @@ The application is built with Rust using the Axum web framework. It uses GenAISc
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with web-agent-rs, follow these steps:
|
||||
To get started with open-web-agent-rs, follow these steps:
|
||||
|
||||
1. Read the [Installation Guide](./installation.md) to set up the project
|
||||
2. Configure the application using the [Configuration Guide](./configuration.md)
|
||||
@@ -42,4 +42,4 @@ Please note that this project has not undergone a formal security assessment. Yo
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to web-agent-rs are welcome! Please feel free to submit issues and pull requests to improve the project.
|
||||
Contributions to open-web-agent-rs are welcome! Please feel free to submit issues and pull requests to improve the project.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This document explains how input works for agents in the web-agent-rs project. Understanding how input is processed is essential for creating effective agents and integrating them with client applications.
|
||||
This document explains how input works for agents in the open-web-agent-rs project. Understanding how input is processed is essential for creating effective agents and integrating them with client applications.
|
||||
|
||||
## Input Flow
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before installing web-agent-rs, ensure you have the following prerequisites:
|
||||
Before installing open-open-web-agent-rs, ensure you have the following prerequisites:
|
||||
|
||||
- [Rust](https://www.rust-lang.org/tools/install) (latest stable version)
|
||||
- [Node.js](https://nodejs.org/) (for GenAIScript)
|
||||
@@ -52,12 +52,12 @@ You can also run the application using Docker:
|
||||
|
||||
1. Build the Docker image:
|
||||
```bash
|
||||
docker build -t web-agent-rs -f Dockerfile .
|
||||
docker build -t open-web-agent-rs -f <Local|Remote>.Dockerfile .
|
||||
```
|
||||
|
||||
2. Run the container:
|
||||
```bash
|
||||
docker run -p 3006:3006 --env-file .env web-agent-rs
|
||||
docker run -p 3006:3006 --env-file .env open-web-agent-rs
|
||||
```
|
||||
|
||||
Alternatively, you can use Docker Compose:
|
||||
|
||||
@@ -4,7 +4,7 @@ This document describes how the stream data is formatted as it comes across the
|
||||
|
||||
## Overview
|
||||
|
||||
The web-agent-rs uses Server-Sent Events (SSE) to stream data from agents to clients. This allows for real-time updates as the agent processes the request and generates responses.
|
||||
The open-web-agent-rs uses Server-Sent Events (SSE) to stream data from agents to clients. This allows for real-time updates as the agent processes the request and generates responses.
|
||||
|
||||
## Stream Format
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This document outlines the token-based authentication system used in web-agent-rs. The system uses FIPS204 signatures to
|
||||
This document outlines the token-based authentication system used in open-web-agent-rs. The system uses FIPS204 signatures to
|
||||
generate secure session tokens containing user data.
|
||||
|
||||
## Core Components
|
||||
|
||||
Reference in New Issue
Block a user