# AtlasUI Documentation

Welcome to AtlasUI's documentation. AtlasUI is a comprehensive user interface for MongoDB Atlas,
providing both a web-based interface and CLI tool for managing MongoDB Atlas resources.

```{toctree}
:maxdepth: 2
:caption: Contents

installation
quickstart
features
service_accounts
security
```

## Screenshots

### Dashboard
![Dashboard](images/dashboard.png)

### Organizations
![Organizations](images/organizations.png)

### All Clusters
![All Clusters](images/clusters.png)

### All Projects
![All Projects](images/projects.png)

## Features

* **Web UI**: FastAPI-based web interface for MongoDB Atlas management
* **CLI Tool**: Command-line interface for Atlas operations
* **Complete API Coverage**: Built from official MongoDB Atlas OpenAPI specifications
* **Modern Stack**: FastAPI, Typer, Rich, and modern Python tooling
* **Operation Queue**: Intelligent queuing system for long-running operations with real-time progress tracking
* **Status-Based Polling**: Accurate cluster status monitoring for reliable deletion operations
* **Responsive Design**: Mobile-friendly Bootstrap 5 interface with real-time updates

## Atlas API Coverage

This UI provides access to all MongoDB Atlas administration APIs including:

* **Clusters**: Create, configure, and manage MongoDB clusters
* **Projects**: Manage Atlas projects and organizations
* **Backup & Restore**: Configure backups and restore operations
* **Alerts**: Set up and manage alert configurations
* **Access Control**: Manage users, roles, and API keys
* **Monitoring**: View metrics and performance data
* **Federation**: Configure identity providers and SSO
* **Network Access**: Manage IP access lists and private endpoints

## Indices and tables

* {ref}`genindex`
* {ref}`modindex`
* {ref}`search`