mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-04-28 01:46:23 +02:00
* add the new docs * Update to latest comprehensive docs from mintlify2 branch - Add conversations, jobs, triggers guides - Complete tools documentation - Enhanced RAG and agents docs - Add UI screenshots and images - Update contribution guide and quickstart * added intro gif * Update introduction.mdx with intro gif * Add public/videos folder with Intro-Video.gif for proper Next.js/Mintlify serving * updated gif * Update introduction.mdx to have a working intro gif
32 lines
No EOL
1.8 KiB
Text
32 lines
No EOL
1.8 KiB
Text
# Open Source Installation
|
|
|
|
- This is the developers guide to self-hosting the open-source version of RowBoat. To get started with the hosted app, please see [Using the Hosted App](/hosted_setup)
|
|
- Please see our [Introduction](/) page before referring to this guide.
|
|
- For direct installation steps, please head to the README of RowBoat's Github repo: [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/). This page provides more context about the installation process and the different components involved.
|
|
|
|
## Overview
|
|
|
|
RowBoat's codebase has three main components:
|
|
|
|
| Component | Description |
|
|
|--------------|---------------|
|
|
| **Agents** | Python framework responsible for carrying out multi-agent conversations |
|
|
| **Copilot** | Python framework powering the copilot in RowBoat Studio |
|
|
| **RowBoat** | Frontend and backend services to power RowBoat Studio and Chat APIs |
|
|
|
|
These components are structured as separate services, each containerized with Docker. Running `docker-compose up --build` enables you to use the Studio in your browser, as well as stands up the APIs and SDK.
|
|
|
|
## Prerequisites
|
|
All of these prerequisites have open-source or free versions.
|
|
|
|
| Prerequisite | Description |
|
|
|--------------|---------------|
|
|
| **Docker** | Bundles and builds all services |
|
|
| **OpenAI API Key** | Agents and Copilot services are powered by OpenAI LLMs |
|
|
| **MongoDB** | Stores workflow versions, chats and RAG embeddings |
|
|
|
|
Refer to our [Github Readme for Prerequisites](https://github.com/rowboatlabs/rowboat/?tab=readme-ov-file#prerequisites) to set up prerequisites.
|
|
|
|
## Setting up
|
|
|
|
Refer to our [Github Readme for Local Development](https://github.com/rowboatlabs/rowboat/?tab=readme-ov-file#local-development-setup) to set up Studio, Chat API and SDK via `docker-compose`. |