Quickstart

​

Installation Options

You can use Gurubase in two ways:

1. Gurubase.io - Start using immediately without any setup
2. 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 or docker-compose) 2.30.x or later.
• OpenAI API key (for answer generation and embeddings). Get it from here.

​

Quick Install

Run this command to install Gurubase:

curl -fsSL https://raw.githubusercontent.com/Gurubase/gurubase/refs/heads/master/gurubase.sh -o gurubase.sh
bash gurubase.sh

The installer will:

1. Create a .gurubase directory in your home folder
2. Download and start all necessary services
3. 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

​

Architecture Overview

Gurubase follows a microservices architecture designed for scalability and performance. Here’s a quick overview of the key components:

​

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.

​

Next Steps