Getting started
What are copilots? (start from here)
Introduction to OpenCopilot. start from here for step-by-step guide
Setting up
Install the project locally and make it yours
Create copilots
Create copilots programmatically (APIs, SDKs) or using the dashboard
Authentications and Authorization
Handle Authentications and Authorization to your backend
Embedding copilots on your app
How to use OpenCopilot widget and embed it on your web app
Creating complex flows
Learn how to use OpenCopilot flows definition
Roadmap
See what’s coming next.
Setting up
You can self-host OpenCopilot in a relatively easy way, please make sure you have the following requirements:- Docker engine and docker compose installed
- Clone the repository
- Update your llm-server/.env with your OPENAI_API_KEY
- Run the installation script
You also can see the complete list of commands using
make help
Complete list of links:
- http://localhost:8888/backend -> backend APIs (create, update, delete and validate copilots)
- http://localhost:8888 or http://localhost:8888/dashbaord -> dashboard (UI to do the same)