deploy-authentication.md

Authentication

big-AGI does not come with built-in authentication. To secure your deployment, you can implement authentication in one of the following ways:

1. Build big-AGI with support for ⬇️ HTTP Authentication
2. Utilize user authentication features provided by your ⬇️ cloud deployment platform
3. Develop a custom authentication solution

HTTP Authentication

HTTP Basic Authentication is a simple method to secure your application.

To enable it in big-AGI, you must manually build the application:

• Build big-AGI with HTTP authentication enabled:

  • Clone the repository
  • Rename middleware_BASIC_AUTH.ts to middleware.ts
  • Build: usual simple build procedure (e.g. Deploy manually or Deploying with Docker)

• Configure the following environment variables before launching big-AGI:

HTTP_BASIC_AUTH_USERNAME=<your username>
HTTP_BASIC_AUTH_PASSWORD=<your password>

• Start the application 🔒

Cloud Deployments Authentication

This approach allows you to enable authentication without rebuilding the application by using the features provided by your cloud platform to manage user accounts and access.

Many cloud deployment platforms offer built-in authentication mechanisms. Refer to the platform's documentation for setup instructions:

1. CloudFlare Access / Zero Trust
2. Vercel Authentication
3. Vercel Password Protection
4. Let us know when you test more solutions (Heroku, AWS IAM, Google IAP, etc.)