> ## Documentation Index
> Fetch the complete documentation index at: https://opensource.weam.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

## Step 1: Choose Your Setup

Pick the setup method that fits your needs:

> [card] [Local Setup (Development)](https://opensource.weam.ai/docs/setup/choose-your-setup/local-setup.md)
>
> Run Weam AI on your local machine for development, testing, or evaluation.

> [card] [One-Click Cloud Deployment](https://opensource.weam.ai/docs/setup/choose-your-setup/deploy-on-cloud.md)
>
> Deploy instantly on AWS or DigitalOcean with automated setup scripts.

> [card] [On Prem Setup (Production)](https://opensource.weam.ai/docs/setup/choose-your-setup/on-prem.md)
>
> Deploy Weam AI on your own infrastructure with custom domain and SSL.

### Which Setup Should I Choose?

| Setup Type | Best For | Requirements | Time |
| - | - | - | - |
| **Local Setup** | Development, testing | Docker, 8GB RAM | 10-15 min |
| **One-Click Cloud** | Quick production deployment | Cloud account, optional domain | 5-30 min |
| **On Prem** | Custom infrastructure | Linux server, domain, SSL | 20-30 min |

> [!TIP]
>
> **New to Weam AI?**
>
> Start with **One-Click Cloud Deployment** for the fastest way to get a production-ready instance running with minimal configuration.

## Step 2: Complete Configuration

After installation, follow these essential configuration steps:

**1. Configure Environment Variables**

Set up database connections, security keys, and service endpoints.

> [card] [Environment Variables Guide](https://opensource.weam.ai/docs/setup/after-setup-complete/environment-variables.md)
>
> Complete reference for all configuration options

**2. Add Your Credentials**

Connect to model providers like OpenAI, Anthropic, and Google.

> [card] [Credential Setup Guide](https://opensource.weam.ai/docs/setup/after-setup-complete/credential-setup.md)
>
> Step-by-step credential generation and configuration

**3. Launch and Verify**

Start services and confirm everything works correctly.

> [card] [Launch & Verify Guide](https://opensource.weam.ai/docs/setup/after-setup-complete/launch-verify.md)
>
> Verify installation and test core functionality

## What Happens Next?

Once setup is complete, you'll have:

* A running Weam AI instance accessible via web browser
* Connected model providers for chat functionality
* User registration and login working
* Core features like Brains, Prompts, and Agents ready to use

## Time Estimates

| Setup Phase | Estimated Time |
| - | - |
| Local Installation | 10-15 minutes |
| On Prem Installation | 20-30 minutes |
| Environment Configuration | 10-15 minutes |
| Credential Setup | 15-20 minutes |
| **Total Setup Time** | **30-60 minutes** |

> [!NOTE]
>
> One-Click Cloud deployment includes automated infrastructure provisioning, making it faster overall despite the longer total time.

## Need Help?

> [accordion] Installation Issues
>
> * Check that Docker is running and has enough memory allocated
> * Ensure all required ports are available
> * Verify your system meets minimum requirements (8GB RAM, 4 CPU cores)

> [accordion] Configuration Problems
>
> * Double-check environment variable syntax
> * Confirm API keys are valid and have proper permissions
> * Check database and Redis connections

> [accordion] Access Issues
>
> * Verify firewall settings allow required ports
> * Check DNS configuration for on-prem setups
> * Confirm SSL certificates are properly installed


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.