Compare commits
2 Commits
e130969cd9
...
feat/CAI-2
| Author | SHA1 | Date | |
|---|---|---|---|
|
7ab2cc27f4 | ||
|
|
56fd1d46b6 |
154
README.md
154
README.md
@@ -1,64 +1,132 @@
|
||||
# CERTifAI
|
||||
<p align="center">
|
||||
<img src="assets/favicon.svg" width="96" height="96" alt="CERTifAI Logo" />
|
||||
</p>
|
||||
|
||||
[](https://gitea.meghsakha.com/sharang/certifai/actions?workflow=ci.yml)
|
||||
[](https://www.rust-lang.org/)
|
||||
[](https://dioxuslabs.com/)
|
||||
[](LICENSE)
|
||||
[](https://gdpr.eu/)
|
||||
<h1 align="center">CERTifAI</h1>
|
||||
|
||||
This project is a SaaS application dashboard for administation of self-hosted private GenAI (generative AI) toolbox for companies and individuals. The purpose of the dashboard is to manage LLMs, Agents, MCP Servers and other GenAI related features.
|
||||
|
||||
The purpose of `CERTifAI`is to provide self-hosted or GDPR-Conform GenAI infrastructure to companies who do not wish to subscribe to non-EU cloud providers to protect their intellectual property from being used as training data.
|
||||
<p align="center">
|
||||
<strong>Self-hosted, GDPR-compliant GenAI infrastructure dashboard</strong>
|
||||
</p>
|
||||
|
||||
## Overview
|
||||
<p align="center">
|
||||
<a href="https://gitea.meghsakha.com/sharang/certifai/actions?workflow=ci.yml"><img src="https://gitea.meghsakha.com/sharang/certifai/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
|
||||
<a href="https://www.rust-lang.org/"><img src="https://img.shields.io/badge/Rust-1.89-orange?logo=rust&logoColor=white" alt="Rust" /></a>
|
||||
<a href="https://dioxuslabs.com/"><img src="https://img.shields.io/badge/Dioxus-0.7-blue?logo=webassembly&logoColor=white" alt="Dioxus" /></a>
|
||||
<a href="https://www.mongodb.com/"><img src="https://img.shields.io/badge/MongoDB-8.0-47A248?logo=mongodb&logoColor=white" alt="MongoDB" /></a>
|
||||
<a href="https://www.keycloak.org/"><img src="https://img.shields.io/badge/Keycloak-26-4D4D4D?logo=keycloak&logoColor=white" alt="Keycloak" /></a>
|
||||
<a href="https://tailwindcss.com/"><img src="https://img.shields.io/badge/Tailwind_CSS-4-06B6D4?logo=tailwindcss&logoColor=white" alt="Tailwind CSS" /></a>
|
||||
<a href="https://daisyui.com/"><img src="https://img.shields.io/badge/DaisyUI-5-5A0EF8?logo=daisyui&logoColor=white" alt="DaisyUI" /></a>
|
||||
</p>
|
||||
|
||||
The SaaS application dashboard is the landing page for the company admin to view, edit and manage the company internal GenAI tools. The following tasks can be performed by the administrator:
|
||||
<p align="center">
|
||||
<a href="https://gdpr.eu/"><img src="https://img.shields.io/badge/GDPR-Compliant-green" alt="GDPR" /></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Proprietary-red" alt="License" /></a>
|
||||
<img src="https://img.shields.io/badge/Platform-Linux%20%7C%20Docker-lightgrey?logo=linux&logoColor=white" alt="Platform" />
|
||||
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs Welcome" />
|
||||
</p>
|
||||
|
||||
- User management: Can add, remove, set roles, permissions and add restrictions for other users.
|
||||
- SSO/Oauth/LDAP: Can connect to company internal SSO/LDAP or other identity provider to load users and their respective permissions.
|
||||
- Turn features on/off: Turn off/on different GenAI features
|
||||
- Billing: View the current seats being used and token usage per seat for any given billing cycle
|
||||
- Request support: Request support or new features using feedback form
|
||||
- GenAI: View currently running LLMs, Agents, MCP Servers. Modify or add more resources, switch to a different model, launch tools like Langchain + Langfuse for creating new agents,tavily for internet search or more complex tools for use with GenAI. View endpoints and generate API Keys for integrations in other applications.
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
CERTifAI is a SaaS dashboard for administering self-hosted private GenAI infrastructure. It gives companies and individuals a single pane of glass to manage LLMs, Agents, MCP Servers, and other GenAI-related services -- without sending data to non-EU cloud providers.
|
||||
|
||||
> **Why?** Protect your intellectual property from being used as training data. Stay fully GDPR-compliant with infrastructure you own.
|
||||
|
||||
## Features
|
||||
|
||||
| Area | Capabilities |
|
||||
|------|-------------|
|
||||
| **User Management** | Add, remove, set roles, permissions, and restrictions |
|
||||
| **SSO / OAuth / LDAP** | Connect to company identity providers and sync users |
|
||||
| **Feature Flags** | Toggle GenAI features on or off per-org |
|
||||
| **Billing** | View seat usage and token consumption per billing cycle |
|
||||
| **Support** | Request support or new features via feedback form |
|
||||
| **GenAI Tools** | Manage LLMs, Agents, MCP Servers; launch Langchain, Langfuse, Tavily; view endpoints and generate API keys |
|
||||
|
||||
## Dashboard
|
||||
|
||||
The main dashboard provides a news feed powered by SearXNG and Ollama:
|
||||
The main dashboard provides a news feed powered by **SearXNG** and **Ollama**:
|
||||
|
||||
- **Topic-based search**: Browse AI, Technology, Science, Finance and custom topics. Add or remove topics on the fly; selections persist in localStorage.
|
||||
- **Article detail + AI summary**: Click any card to open a split-view panel. The full article is fetched, summarized by Ollama, and a follow-up chat lets you ask questions.
|
||||
- **Topic-based search** -- Browse AI, Technology, Science, Finance, and custom topics. Add or remove topics on the fly; selections persist in localStorage.
|
||||
- **Article detail + AI summary** -- Click any card to open a split-view panel. The full article is fetched, summarized by Ollama, and a follow-up chat lets you ask questions.
|
||||
- **Sidebar** (visible when no article is selected):
|
||||
- **Ollama Status** -- green/red indicator with the list of loaded models.
|
||||
- **Trending** -- keywords extracted from recent news headlines via SearXNG.
|
||||
- **Recent Searches** -- last 10 topics you searched, persisted in localStorage.
|
||||
- **Ollama Status** -- green/red indicator with the list of loaded models
|
||||
- **Trending** -- keywords extracted from recent news headlines via SearXNG
|
||||
- **Recent Searches** -- last 10 topics you searched, persisted in localStorage
|
||||
|
||||
## Development environment
|
||||
## Tech Stack
|
||||
|
||||
This project is written in Dioxus 0.7 with fullstack and router features. MongoDB is used as a database for maintaining user state. Keycloak is used as identity provider for user management.
|
||||
| Layer | Technology |
|
||||
|-------|-----------|
|
||||
| Frontend | [Dioxus 0.7](https://dioxuslabs.com/) (fullstack + router), Tailwind CSS 4, DaisyUI 5 |
|
||||
| Backend | Axum, tower-sessions, Dioxus server functions |
|
||||
| Database | MongoDB |
|
||||
| Auth | Keycloak 26+ (OAuth2 + PKCE, Organizations) |
|
||||
| Search | SearXNG (meta-search) |
|
||||
| LLM | Ollama (local inference) |
|
||||
|
||||
### External services
|
||||
## Getting Started
|
||||
|
||||
| Service | Purpose | Default URL |
|
||||
|----------|--------------------------------|----------------------------|
|
||||
| Keycloak | Identity provider / SSO | `http://localhost:8080` |
|
||||
| SearXNG | Meta-search engine for news | `http://localhost:8888` |
|
||||
| Ollama | Local LLM for summarization | `http://localhost:11434` |
|
||||
### Prerequisites
|
||||
|
||||
Copy `.env.example` to `.env` and adjust the URLs and model name to match your setup.
|
||||
- Rust 1.89+
|
||||
- [Dioxus CLI](https://dioxuslabs.com/learn/0.7/getting_started) (`dx`)
|
||||
- MongoDB
|
||||
- Keycloak
|
||||
- SearXNG (optional)
|
||||
- Ollama (optional)
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://gitea.meghsakha.com/sharang/certifai.git
|
||||
cd certifai
|
||||
|
||||
# Configure environment
|
||||
cp .env.example .env
|
||||
# Edit .env with your Keycloak, MongoDB, and service URLs
|
||||
|
||||
# Run the dev server
|
||||
dx serve
|
||||
```
|
||||
|
||||
### External Services
|
||||
|
||||
| Service | Purpose | Default URL |
|
||||
|---------|---------|-------------|
|
||||
| Keycloak | Identity provider / SSO | `http://localhost:8080` |
|
||||
| MongoDB | User data and preferences | `mongodb://localhost:27017` |
|
||||
| SearXNG | Meta-search engine for news | `http://localhost:8888` |
|
||||
| Ollama | Local LLM for summarization | `http://localhost:11434` |
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
components/ Frontend-only reusable UI components
|
||||
infrastructure/ Server-side: auth, config, DB, server functions
|
||||
models/ Shared data models (web + server)
|
||||
pages/ Full page views composing components + models
|
||||
assets/ Static assets (CSS, icons, manifest)
|
||||
styles/ Tailwind/DaisyUI input stylesheet
|
||||
bin/ Binary entrypoint
|
||||
```
|
||||
|
||||
## Code structure
|
||||
The following folder structure is maintained for separation of concerns:
|
||||
- src/components/*.rs : All components that are required to be rendered are placed here. These are frontend only, reusable components that are specific for the application.
|
||||
- src/infrastructure/*.rs : All backend related functions from the dioxus fullstack are placed here. This entire module is behind the feature "server".
|
||||
- src/models/*.rs : All data models for use by the frontend pages and components.
|
||||
- src/pages/*.rs : All view pages for the website, which utilize components, models to render the entire page. The pages are more towards the user as they group user-centered functions together in one view.
|
||||
|
||||
|
||||
## Git Workflow
|
||||
|
||||
We follow feature branch workflow for Git and bringing in new features. The `main` branch is the default and protected branch.
|
||||
Conventional commits MUST be used for writing commit messages. We follow semantic versioning as per [SemVer](https://semver.org)
|
||||
We follow the **feature branch workflow**. The `main` branch is the default and protected branch.
|
||||
|
||||
- [Conventional Commits](https://www.conventionalcommits.org/) are required for all commit messages
|
||||
- We follow [SemVer](https://semver.org/) for versioning
|
||||
|
||||
## CI
|
||||
|
||||
The CI is run on gitea actions with runner tags `docker`.
|
||||
CI runs on Gitea Actions with runner tag `docker`.
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>Built with Rust, Dioxus, and a commitment to data sovereignty.</sub>
|
||||
</p>
|
||||
|
||||
@@ -96,7 +96,7 @@ pub fn Sidebar(name: String, email: String, avatar_url: String) -> Element {
|
||||
|
||||
div { class: "sidebar-bottom-actions",
|
||||
Link {
|
||||
to: NavigationTarget::<Route>::External("/auth/logout".into()),
|
||||
to: NavigationTarget::<Route>::External("/logout".into()),
|
||||
class: "sidebar-link logout-btn",
|
||||
Icon { icon: BsBoxArrowRight, width: 18, height: 18 }
|
||||
span { "Logout" }
|
||||
|
||||
Reference in New Issue
Block a user