Sign inSign up

abdofallah/iqraai-docs

By abdofallah

โ€ขUpdated 7 months ago

Official documentation for Iqra AI โ€“ The Dynamic AI-First Computing Engine

Image
1

2.3K

abdofallah/iqraai-docs repository overview

โ Iqra AI Documentation

Iqra AI Banner โ 
โ The Dynamic AI-First Computing Engine

Official documentation container for Iqra AIโ .
Live Documentation ยปโ 

Source Codeโ  ยท Main Platform Repoโ  ยท Join Communityโ 


โ ๐Ÿ“š Overview

This image contains the production build of docs.iqra.botโ . It is a Next.js application running in standalone mode, built using Fumadocsโ .

It serves the complete documentation for the Iqra AI ecosystem, covering:

  • Introduction: Philosophy & Architecture.
  • Platform: User Dashboard & Whitelabeling.
  • Build & Deploy: The Visual Script Builder, Agents, Tools/Connections, Rag/Data & Route/Campaigns.
  • Integrations: Providers, LLM/STT/TTS, Rerank, Embedding, FlowApps & Telephony.
  • Developers: Self-Hosting & FlowApp Development.
  • API Reference: OpenAPI based dynamic API references.

โ ๐Ÿš€ Quick Start

โ Run with Docker CLI

You can spin up the documentation locally on port 5000 with a single command:

docker run -d \
  --name iqra-docs \
  -p 5000:5000 \
  --restart always \
  abdofallah/iqraai-docs:latest

Once running, access the docs at http://localhost:5000.

โ Run with Docker Compose

If you are deploying this as part of the larger Iqra AI self-hosted stack, add this service to your docker-compose.yml:

services:
  docs:
    image: abdofallah/iqraai-docs:latest
    container_name: iqra-docs
    restart: always
    ports:
      - "5000:5000"
    environment:
      - NODE_ENV=production
      - PORT=5000

โ ๐Ÿท๏ธ Tags

  • latest: The most recent stable build from the main branch.
  • sha-xxxx: Specific commits for version pinning (useful for production stability).

โ ๐Ÿ”ง Environment Variables

This container is pre-configured for production. However, you can override standard Next.js settings:

VariableDefaultDescription
PORT5000The internal port the server listens on.
NODE_ENVproductionOptimization mode.
HOSTNAME0.0.0.0Binding address.

โ ๐Ÿค Contributing

The documentation source code is Open Source. If you find a typo or want to add a guide:

  1. Visit the GitHub Repositoryโ .
  2. Edit the files in content/docs.
  3. Submit a Pull Request.

Tag summary

Content type

Image

Digest

sha256:00dc72788โ€ฆ

Size

99.9 MB

Last updated

7 months ago

docker pull abdofallah/iqraai-docs