Skip to content

AI Apps - Installation & Running the Platform

This guide explains how to install prerequisites and run the AI Apps platform using the provided startup scripts.


Before starting the platform, ensure the following are available:

  • Operating System Requirements

    • Windows: Win10 or Win11
    • Linux: Ubuntu, Redhat
    • MacOS
  • Resources:

    • vCPU 4 Core
    • RAM 8 GB
    • Storage 50 GB SSD
    • OS Ubuntu 22.04 LTS or Above
    • Docker Docker CE + Compose
    • Network Public IP + DNS

These are the minimum requirements. The optimal number would depend on number of concurrent users. The API traffic based on AI usage, and the number of requests sent through the system

Required container images are pulled automatically when you start the platform for the first time.

Images typically included:

  • oogy-api
  • chat-api
  • enterprise-mesh-api
  • smart-functions-ui

Edit the .env file in the project root.

Example:

SERVER_NAME=ai-apps.domain-name.com
SSL_CERT=./nginx/certs/server.crt
SSL_KEY=./nginx/certs/server.key
Variable Description
SERVER_NAME Domain name used by the application
SSL_CERT Path to SSL certificate
SSL_KEY Path to SSL private key

Choose one approach based on how you will access the platform.

If you are running the stack locally and want your browser to reach the containers, map the same hostname as SERVER_NAME (and NEXTAUTH_URL, if used) to 127.0.0.1.

Windows

  • Hosts file: C:\Windows\System32\drivers\etc\hosts
  • Add:
127.0.0.1 ai-apps.domain-name.com

macOS / Linux

  • Hosts file: /etc/hosts
  • Add:
127.0.0.1 ai-apps.domain-name.com

You typically need Administrator (Windows) / sudo (macOS/Linux) to edit the hosts file.

If you are using a public IP and public DNS, add the public IP of your device/VM in your DNS provider.

Example:

  • IP of VM or device: 192.168.1.2
  • DNS provider record:
    • Record Type: A
    • Host: ai-apps
    • Value: 192.168.1.2

Run the startup script from the project root.

Terminal window
./ai-apps.sh start
Terminal window
.\ai-apps.ps1 start

The script will:

  • Load environment variables
  • Validate SSL configuration
  • Pull latest images (first time)
  • Start all containers

Open:

https://<SERVER_NAME>

Example:

https://ai-apps.domain-name.com

Terminal window
./ai-apps.sh stop
Terminal window
.\ai-apps.ps1 stop

Use this when you want to pull newer images.

Windows (PowerShell)

Terminal window
.\ai-apps.ps1 update

macOS / Linux

Terminal window
./ai-apps.sh update

Restart after an update:

stop -> start

Terminal window
.\ai-apps.ps1 --help
.\ai-apps.ps1 start
.\ai-apps.ps1 stop
.\ai-apps.ps1 status
.\ai-apps.ps1 logs
.\ai-apps.ps1 update
Terminal window
./ai-apps.sh --help
./ai-apps.sh start
./ai-apps.sh stop
./ai-apps.sh status
./ai-apps.sh logs
./ai-apps.sh update

To enable HTTPS without browser security warnings, a valid SSL certificate is required.

If you already have an SSL certificate for your domain, provide:

  • Certificate file (.crt or full chain certificate)
  • Private key file (.key)

Place them at:

  • nginx/certs/server.crt
  • nginx/certs/server.key

Or update .env to point SSL_CERT/SSL_KEY to the correct paths.

Option 2) Generate a free Let’s Encrypt certificate

Section titled “Option 2) Generate a free Let’s Encrypt certificate”
  • You own the domain name.
  • The domain’s DNS records point to your server.
  • Ports 80 and 443 are accessible from the internet.

Walkthrough: https://certbot.eff.org/

Ubuntu/Debian:

Terminal window
sudo apt update
sudo apt install certbot

Generate the certificate:

Terminal window
sudo certbot certonly --standalone -d yourdomain.com -d www.yourdomain.com

Certificate location:

/etc/letsencrypt/live/yourdomain.com/fullchain.pem
/etc/letsencrypt/live/yourdomain.com/privkey.pem

Renewal:

Terminal window
sudo certbot renew

Walkthrough: https://www.win-acme.com/

  1. Download and extract win-acme.
  2. Run wacs.exe as Administrator.
  3. Create a new certificate and enter your domain name(s) (for example example.com, www.example.com).
  4. Export or copy the resulting certificate/key to the locations used by your .env.

  • Ensure SSL certificate files exist at the paths configured in .env.
  • Changes to .env require restarting the containers.