Get Started
Quickstart
Get started with Gurubase in minutes
Installation Options
You can use Gurubase in two ways:
- Gurubase.io - Start using immediately without any setup
- Self-hosted - Deploy on your own infrastructure
Self-hosted Installation
Prerequisites
Before installation, ensure you have:
- Docker
27.3.x
or later. - Docker Compose (
docker compose
ordocker-compose
)2.30.x
or later. - For answer generation and embeddings, one of the following:
- OpenAI API key. Get it from here.
- Ollama installation, alongside installed models to be used for embedding and language.
Ollama support is currently in beta and available to selected users. Therefore, you may not see it in the AI Model Provider options.
Quick Install
Run this command to install Gurubase:
The installer will:
- Create a
.gurubase
directory in your home folder - Download and start all necessary services
- Open the web interface at
http://localhost:8029
System Requirements
- Supported OS: Linux and macOS (Windows via WSL2)
- CPU: 4 cores minimum
- RAM: 8GB minimum
- Storage: 10GB SSD
- Ports: 8028 and 8029 must be available
Only Linux and macOS are supported. For Windows users, please use WSL2.
Architecture Overview
Gurubase follows a microservices architecture designed for scalability and performance. Here’s a quick overview of the key components:
For detailed architecture documentation, including system diagrams, data flows, and configuration options, see our Architecture Guide on GitHub.
Additional Resources
For detailed information about:
- Advanced configuration
- System architecture
- Available services
- Data storage
- Security considerations
- Upgrade and removal instructions
Please visit our GitHub repository for more information.