{"id":13706923,"url":"https://github.com/amjadraza/langchain-chainlit-docker-deployment-template","last_synced_at":"2025-05-05T23:31:52.497Z","repository":{"id":175126185,"uuid":"653021638","full_name":"amjadraza/langchain-chainlit-docker-deployment-template","owner":"amjadraza","description":"A template to run Lanchain Powered App using Chainlit Front UI","archived":false,"fork":false,"pushed_at":"2024-05-02T14:44:21.000Z","size":450,"stargazers_count":44,"open_issues_count":2,"forks_count":48,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-13T15:49:14.294Z","etag":null,"topics":["chainlit","chatapp","docker","google","google-cloud-platform","langchain"],"latest_commit_sha":null,"homepage":"https://langchain-chat-app-ex6cbrefpq-ts.a.run.app/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amjadraza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-13T09:01:52.000Z","updated_at":"2024-08-22T04:57:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"65092fb7-bcd0-4482-bdd8-9c61b0505ece","html_url":"https://github.com/amjadraza/langchain-chainlit-docker-deployment-template","commit_stats":null,"previous_names":["amjadraza/langchain-chainlit-docker-deployment-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amjadraza%2Flangchain-chainlit-docker-deployment-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amjadraza%2Flangchain-chainlit-docker-deployment-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amjadraza%2Flangchain-chainlit-docker-deployment-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amjadraza%2Flangchain-chainlit-docker-deployment-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amjadraza","download_url":"https://codeload.github.com/amjadraza/langchain-chainlit-docker-deployment-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252593173,"owners_count":21773421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chainlit","chatapp","docker","google","google-cloud-platform","langchain"],"created_at":"2024-08-02T22:01:12.699Z","updated_at":"2025-05-05T23:31:49.280Z","avatar_url":"https://github.com/amjadraza.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n📖 LangChain-Chainlit-Docker-Deployment App Template\n\u003c/h1\u003e\n\n![UI](ui.PNG?raw=true)\n\n\n## 🔧 Features\n\n- Basic Skeleton App configured with `openai` API\n- A ChatBot using LangChain and Chainlit\n- Docker Support with Optimisation Cache etc\n- Deployment on Google Cloud App Engine\n- Deployment on Google Cloud using `Cloud Run`\n\n\u003e Reference repository: https://github.com/amjadraza/langchain-streamlit-docker-template\n\nThis repo contains an `main.py` file which has a template for a chatbot implementation.\n\n## Adding your chain\nTo add your chain, you need to change the `load_chain` function in `main.py`.\nDepending on the type of your chain, you may also need to change the inputs/outputs that occur later on.\n\n\n## 💻 Running Locally\n\n1. Clone the repository📂\n\n```bash\ngit clone https://github.com/amjadraza/langchain-chainlit-docker-deployment-template\n```\n\n2. Install dependencies with [Poetry](https://python-poetry.org/) and activate virtual environment🔨\n\n```bash\npoetry install\npoetry shell\n```\n\n3. Run the Chainlit server🚀\n\n```bash\nchainlit run demo_app/main.py\n```\n\nRun App using Docker\n--------------------\nThis project includes `Dockerfile` to run the app in Docker container. In order to optimise the Docker Image\nsize and building time with cache techniques, I have follow tricks in below Article \nhttps://medium.com/@albertazzir/blazing-fast-python-docker-builds-with-poetry-a78a66f5aed0\n\nBuild the docker container\n\n``docker  build . -t langchain-chainlit-chat-app:latest``\n\nTo generate Image with `DOCKER_BUILDKIT`, follow below command\n\n```DOCKER_BUILDKIT=1 docker build --target=runtime . -t langchain-chainlit-chat-app:latest```\n\n1. Run the docker container directly \n\n``docker run -d --name langchain-chainlit-chat-app -p 8000:8000 langchain-chainlit-chat-app ``\n\n2. Run the docker container using docker-compose (Recommended)\n\n``docker-compose up``\n\n\nDeploy App on Google App Engine\n--------------------------------\nThis app can be deployed on Google App Engine following below steps.\n\n## Prerequisites\n\nFollow below guide on basic Instructions.\n[How to deploy Streamlit apps to Google App Engine](https://dev.to/whitphx/how-to-deploy-streamlit-apps-to-google-app-engine-407o)\n\nWe added below tow configurations files \n\n1. `app.yaml`: A Configuration file for `gcloud`\n2. `.gcloudignore` : Configure the file to ignore file / folders to be uploaded\n\nI have adopted `Dockerfile` to deploy the app on GCP APP Engine.\n\n1. Initialise \u0026 Configure the App\n\n``gcloud app create --project=[YOUR_PROJECT_ID]``\n\n2. Deploy the App using\n\n``gcloud app deploy``\n\n3. Access the App using \n\nhttps://langchain-chat-app-ex6cbrefpq-ts.a.run.app/\n\n\nDeploy App on Google Cloud using Cloud Run (RECOMMENDED)\n--------------------------------------------------------\nThis app can be deployed on Google Cloud using Cloud Run following below steps.\n\n## Prerequisites\n\nFollow below guide on basic Instructions.\n[How to deploy Streamlit apps to Google App Engine](https://dev.to/whitphx/how-to-deploy-streamlit-apps-to-google-app-engine-407o)\n\nWe added below tow configurations files \n\n1. `cloudbuild.yaml`: A Configuration file for `gcloud`\n2. `.gcloudignore` : Configure the file to ignore file / folders to be uploaded\n\nwe are going to use `Dockerfile` to deploy the app using Google Cloud Run.\n\n1. Initialise \u0026 Configure the Google Project using Command Prompt\n\n`gcloud app create --project=[YOUR_PROJECT_ID]`\n\n2. Enable Services for the Project\n\n```\ngcloud services enable cloudbuild.googleapis.com\ngcloud services enable run.googleapis.com\n```\n\n3. Create Service Account\n\n```\ngcloud iam service-accounts create langchain-app-cr \\\n    --display-name=\"langchain-app-cr\"\n\ngcloud projects add-iam-policy-binding langchain-chat \\\n    --member=\"serviceAccount:langchain-app-cr@langchain-chat.iam.gserviceaccount.com\" \\\n    --role=\"roles/run.invoker\"\n\ngcloud projects add-iam-policy-binding langchain-chat \\\n    --member=\"serviceAccount:langchain-app-cr@langchain-chat.iam.gserviceaccount.com\" \\\n    --role=\"roles/serviceusage.serviceUsageConsumer\"\n\ngcloud projects add-iam-policy-binding langchain-chat \\\n    --member=\"serviceAccount:langchain-app-cr@langchain-chat.iam.gserviceaccount.com\" \\\n    --role=\"roles/run.admin\"\n``` \n\n4. Generate the Docker\n\n`DOCKER_BUILDKIT=1 docker build --target=runtime . -t australia-southeast1-docker.pkg.dev/langchain-chat/clapp/langchain-chainlit-chat-app:latest`\n\n5. Push Image to Google Artifact's Registry\n\nCreate the repository with name `clapp`\n\n```\ngcloud artifacts repositories create clapp \\\n    --repository-format=docker \\\n    --location=australia-southeast1 \\\n    --description=\"A Langachain Chainlit App\" \\\n    --async\n```\n\nConfigure-docker \n\n`gcloud auth configure-docker australia-southeast1-docker.pkg.dev`\n\nIn order to push the `docker-image` to Artifact registry, first create app in the region of choice. \n\nCheck the artifacts locations\n\n`gcloud artifacts locations list`\n\n\n\nOnce ready, let us push the image to location\n\n`docker push australia-southeast1-docker.pkg.dev/langchain-chat/clapp/langchain-chainlit-chat-app:latest`\n\n6. Deploy using Cloud Run\n\nOnce image is pushed to Google Cloud Artifacts Registry. Let us deploy the image.\n\n```\ngcloud run deploy langchain-chat-app --image=australia-southeast1-docker.pkg.dev/langchain-chat/clapp/langchain-chainlit-chat-app:latest \\\n    --region=australia-southeast1 \\\n    --service-account=langchain-app-cr@langchain-chat.iam.gserviceaccount.com \\\n    --port=8000\n```\n\n7. Test the App Yourself\n\nYou can try the app using below link \n\nhttps://langchain-chat-app-ex6cbrefpq-ts.a.run.app/\n\n\n## Report Feedbacks\n\nAs `langchain-chainlit-docker-deployment-template` is a template project with minimal example. Report issues if you face any. \n\n## DISCLAIMER\n\nThis is a template App, when using with openai_api key, you will be charged a nominal fee depending\non number of prompts etc.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famjadraza%2Flangchain-chainlit-docker-deployment-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famjadraza%2Flangchain-chainlit-docker-deployment-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famjadraza%2Flangchain-chainlit-docker-deployment-template/lists"}