8000 GitHub - jeremylgl2/azurechatgpt: 🤖 Azure ChatGPT: Private & secure ChatGPT for internal enterprise use 💼
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

jeremylgl2/azurechatgpt

BranchesTags
 
 

Repository files navigation

Unleash the Power of Azure Open AI

ChatGPT has grown explosively in popularity as we all know now. Business users across the globe often tap into the public service to work more productively or act as a creative assistant.

However, ChatGPT risks exposing confidential intellectual property. One option is to block corporate access to ChatGPT, but people always find workarounds. This also limits the powerful capabilities of ChatGPT and reduces employee productivity and their work experience.

Azure ChatGPT is our enterprise option. This is the exact same service but offered as your private ChatGPT.

Benefits are:

1. Private: Built-in guarantees around the privacy of your data and fully isolated from those operated by OpenAI.

2. Controlled: Network traffic can be fully isolated to your network and other enterprise grade security controls are built in.

3. Value: Deliver added business value with your own internal data sources (plug and play) or use plug-ins to integrate with your internal services (e.g., ServiceNow, etc).

We've built a Solution Accelerator to empower your workforce with Azure ChatGPT.

📘 Prerequisites

  1. Azure OpenAI: To deploy and run ChatGPT on Azure, you'll need an Azure subscription with access to the Azure OpenAI service. Request access here. Once you have access, follow the instructions in this link to deploy the gpt-35-turbo or gpt-4 models.

  2. Setup GitHub or Azure AD for Authentication: The add an identity provider section below shows how to configure authentication providers.

    💡Note: You can configure the authentication provider to your identity solution using NextAuth providers

👋🏻 Introduction

Azure ChatGPT is built with the following technologies.

Node.js 18: an open-source, cross-platform JavaScript runtime environment.

Next.js 13: enables you to create full-stack web applications by extending the latest React features

NextAuth.js: configurable authentication framework for Next.js 13

LangChain JS: AI orchestration layer to build intelligent apps

Tailwind CSS: is a utility-first CSS framework that provides a series of predefined classes that can be used to style each element by mixing and matching

shadcn/ui: re-usable components built using Radix UI and Tailwind CSS.

Azure Cosmos DB: fully managed platform-as-a-service (PaaS) NoSQL database to store chat history

Azure App Service: fully managed platform-as-a-service (PaaS) for hosting web applications, REST APIs, and mobile back ends.

💙 One click Azure deployment

Deploy to Azure

Click on the Deploy to Azure button and configure your settings in the Azure Portal as described in the Environment variables section.

Please see the section below for important information about adding authentication to your app.

👨🏻‍💻 Run from your local machine

Clone this repository locally or fork to your Github account. Run all of the the steps below from the "src" directory.

  1. Make sure you deploy an instance of Cosmos DB in your Azure Subscription
  2. Create a new file named .env.local to store the environment variables add the following variables.

Please note:

  • Do not use double-quotes and do not delete any of the variables.

  • Make sure that NEXTAUTH_URL=http://localhost:3000 has no comments in the same line.

    # Azure OpenAI configuration
AZURE_OPENAI_API_KEY=
AZURE_OPENAI_API_INSTANCE_NAME=
AZURE_OPENAI_API_DEPLOYMENT_NAME=
AZURE_OPENAI_API_VERSION=

# GitHub OAuth app configuration
AUTH_GITHUB_ID=
AUTH_GITHUB_SECRET=

# Azure AD OAuth app configuration
AZURE_AD_CLIENT_ID=
AZURE_AD_CLIENT_SECRET=
AZURE_AD_TENANT_ID=

# When deploying to production,
# set the NEXTAUTH_URL environment variable to the canonical URL of your site.
# More information: https://next-auth.js.org/configuration/options

NEXTAUTH_SECRET=
NEXTAUTH_URL=http://localhost:3000

AZURE_COSMOSDB_URI=
AZURE_COSMOSDB_KEY=
  1. change the active directory to be src
  2. Install npm packages by running npm install
  3. Start the project by running npm run dev

You should now be prompted to login with your chosen OAuth provider. Once successfully logged in, you can start creating new conversations.

☁️ Deploy to Azure - GitHub Actions

🧬 Fork the repository

Fork this repository to your own organisation so that you can execute GitHub Actions against your own Azure Subscription.

🗝️ Configure secrets in your GitHub repository

1. AZURE_CREDENTIALS

The GitHub workflow requires a secret named AZURE_CREDENTIALS to authenticate with Azure. The secret contains the credentials for a service principal with the Contributor role on the resource group containing the container app and container registry.

  1. Create a service principal with the Contributor role on the resource group that contains the Azure App Service.

    az ad sp create-for-rbac
   --name <NAME OF THE CREDENTIAL> --role contributor --scopes /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP> --sdk-auth --output json

  • Copy the JSON output from the command.

  • In the GitHub repository, navigate to Settings > Secrets > Actions and select New repository secret.

  • Enter AZURE_CREDENTIALS as the name and paste the contents of the JSON output as the value.

  • Select Add secret.

    • 2. AZURE_APP_SERVICE_NAME

    Under the same repository secrets add a new variable AZURE_APP_SERVICE_NAME to deploy to your Azure Web app. The value of this secret is the name of your Azure Web app e.g. my-web-app-name from the domain https://my-web-app-name.azurewebsites.net/

    🔄 Run GitHub Actions

    Once the secrets are configured, the GitHub Actions will be triggered for every code push to the repository. Alternatively, you can manually run the workflow by clicking on the "Run Workflow" button in the Actions tab in GitHub.

    🪪 Add an identity provider

    Once the deployment is complete, you will need to add an identity provider to authenticate your app.

    ⚠️ Note: Only one of the identity provider is required below.

    GitHub Authentication provider

    We'll create two GitHub apps: one for testing locally and another for production.

    🟡 Development app setup

    1. Navigate to GitHub OAuth Apps setup https://github.com/settings/developers
    2. Create a New OAuth App https://github.com/settings/applications/new
    3. Fill in the following details
    Application name: Azure ChatGPT DEV Environment
Homepage URL: http://localhost:3000
Authorization callback URL: http://localhost:3000/api/auth/callback/github

    🟢 Production app setup

    1. Navigate to GitHub OAuth Apps setup https://github.com/settings/developers
    2. Create a New OAuth App https://github.com/settings/applications/new
    3. Fill in the following details
    Application name: Azure ChatGPT Production
Homepage URL: https://YOUR-WEBSITE-NAME.azurewebsites.net
Authorization callback URL: https://YOUR-WEBSITE-NAME.azurewebsites.net/api/auth/callback/github

    ⚠️ After completing app setup, ensure your environment variables locally and on Azure App Service are up to date.

       # GitHub OAuth app configuration
   AUTH_GITHUB_ID=
   AUTH_GITHUB_SECRET=

    Azure AD Authentication provider

    🟡 Development app setup

    1. Navigate to Azure AD Apps setup https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps
    2. Create a New Registration https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/CreateApplicationBlade/quickStartType~/null/isMSAApp~/false
    3. Fill in the following details
    Application name: Azure ChatGPT DEV Environment
Supported account types: Accounts in this organizational directory only
Redirect URI Platform: Web
Redirect URI: http://localhost:3000/api/auth/callback/azure-ad

    🟢 Production app setup

    1. Navigate to Azure AD Apps setup https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps
    2. Create a New Registration https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/CreateApplicationBlade/quickStartType~/null/isMSAApp~/false
    3. Fill in the following details
    Application name: Azure ChatGPT Production
Supported account types: Accounts in this organizational directory only
Redirect URI Platform: Web
Redirect URI: https://YOUR-WEBSITE-NAME.azurewebsites.net/api/auth/callback/azure-ad

    ⚠️ After completing app setup, ensure your environment variables locally and on Azure App Service are up to date.

    # Azure AD OAuth app configuration

AZURE_AD_CLIENT_ID=
AZURE_AD_CLIENT_SECRET=
AZURE_AD_TENANT_ID=

    🔑 Environment variables

    Below are the required environment variables, to be added to the Azure Portal or in the .env.local file.

    App Setting Value Note
    AZURE_OPENAI_API_KEY API keys of your Azure OpenAI resource
    AZURE_OPENAI_API_INSTANCE_NAME the name of your Azure OpenAI resource
    AZURE_OPENAI_API_DEPLOYMENT_NAME The name of your model deployment
    AZURE_OPENAI_API_VERSION 2023-03-15-preview API version when using gpt chat
    AUTH_GITHUB_ID Client ID of your GitHub OAuth application
    AUTH_GITHUB_SECRET Client Secret of your GitHub OAuth application
    NEXTAUTH_SECRET Used to encrypt the NextAuth.js JWT, and to hash email verification tokens. This set by default as part of the deployment template
    NEXTAUTH_URL Current webs hosting domain name with HTTP or HTTPS. This set by default as part of the deployment template
    AZURE_COSMOSDB_URI URL of the Azure CosmosDB
    AZURE_COSMOSDB_KEY API Key for Azure Cosmos DB
    AZURE_AD_CLIENT_ID The client id specific to the application
    AZURE_AD_CLIENT_SECRET The client secret specific to the application
    AZURE_AD_TENANT_ID The organisation Tenant ID

    Contributing

    This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

    When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Trademarks

    This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

    About

    🤖 Azure ChatGPT: Private & secure ChatGPT for internal enterprise use 💼

    Resources

    Readme

    License

    MIT license
    Activity

    Stars

    0 stars

    Watchers

    0 watching

    Forks

    0 forks
    Report repository

    Releases

    No releases published

    Packages

    No packages published

    Languages

    • TypeScript 92.8%
    • Bicep 3.1%
    • JavaScript 2.5%
    • CSS 1.6%
    0