Documentation Index

Fetch the complete documentation index at: https://docs.athina.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Athina Self Hosting Guide

​

Prerequisites

• Create an EC2 Instance with at least 64GB of free disk space, 16GB of RAM, and 4 CPUs. Assign a public DNS to the instance as well.
• SSH into the instance and set up the following:
  • Install git
  • Install Docker
  • Install Docker Compose
  • Install nvm and Node.js
  • Install Python 3.9 and pip
  • Install AWS CLI
• Obtain Athina GitHub access credentials.
• Obtain Athina ECR access credentials (AWS CLI is required).

​

Core Services Setup

• Clone the athina-deploy repository (ensure all Athina project folders are at the same directory level):
  git clone https://github.com/athina-ai/athina-deploy
  
• Copy .example.env to .env.
• Populate the respective values. Some default values and keys are provided. You can change them if needed. The DB Name can remain as it is.
• Create a Google OAuth client for Google login (Google Sign-In Documentation). Ensure you set the correct redirect URI and authorized domain (:9000/auth/google/redirect).
• Create a bucket for data import:
  • Use the bucket name specified in .env. Edit CORS setting of this bucket to allow the frontend to upload files:
    [
      {
        "AllowedHeaders": ["*"],
        "AllowedMethods": ["PUT"],
        "AllowedOrigins": ["http://domain:3000"],
        "ExposeHeaders": []
      }
    ]
    

​

Transactional Emails (Optional)

• We use Loops for transactional emails like user invitations, OTP sending, and downloading exported data.
• Create a free account and obtain the API key from the Loops dashboard.
• Create three transactional email templates:
  • User invitation email:
    • Data variables: inviterName and invitedEmail
  • OTP email:
    • Data variable: otp
  • Data export email:
    • Data variable: s3_link

​

Services Creation

• Log in to ECR using credentials:

aws ecr get-login-password --region eu-central-1 | docker login --username AWS --password-stdin 867387325299.dkr.ecr.eu-central-1.amazonaws.com

• Pull the required images:

docker-compose --profile core --profile worker pull

• Ensure that the .env file in athina-deploy is updated with the right values.
• For worker services, ensure the following environment variables are set correctly:

AWS_LAMBDA_API_KEY=<SOME_KEY>
LAMBDA_TRIGGER_WORKER_FUNCTION_URL=http://IP:8000/trigger-job-workers # Change the IP to the IP of the instance.
WORKER_API_KEY=<SOME_KEY> # same as `AWS_LAMBDA_API_KEY`.

• Run the following command to start services:

docker-compose --profile core --profile worker up -d

• Wait for all services to start.

​

Dashboard

• Install Node.js 20+
• Clone the athina-dashboard repository and switch to the main branch:

git clone https://github.com/athina-ai/athina-dashboard
git checkout main

• Ensure you are on the main branch of the athina-dashboard repository.
• Copy the following to .env:

# API URL
NEXT_PUBLIC_API_URL=
# Frontend URL
NEXT_PUBLIC_ATHINA_BASE_URL=

• Set them to the correct values.
• You can build either by installing yarn or by using a pre-built nodejs docker image (Recommended):

yarn install 
npm run build
bash script.sh start

docker run --rm -v $(pwd):/app -w /app node:20 sh -c "yarn install && yarn build"

• Navigate to http://<IP/DOMAIN>:3000/login.

​

Updates

bash script.sh start # Start the services
bash script.sh stop # Stop the services
bash script.sh pull # Pull the latest images
bash script.sh update # Update the services
bash script.sh restart # Restart the services

​

Post Installation

-- Replace 'your_org_id' with the actual org_id
SELECT id FROM org;

-- Query for setting your domain so that further users signing up will be added to your org
UPDATE org SET domain = 'your_domain' WHERE id = 'your_org_id';

-- Set max_evals_per_month to 1000.
UPDATE org SET max_evals_per_month = 1000 WHERE id = 'your_org_id';

-- Paywall org config updated with allowed team members
UPDATE paywall_org_config SET allowed_team_members = 25 WHERE org_id = 'your_org_id';