{"id":15759692,"url":"https://github.com/cedrickring/cora-deploy","last_synced_at":"2026-01-07T23:46:25.584Z","repository":{"id":236055910,"uuid":"791760901","full_name":"cedrickring/cora-deploy","owner":"cedrickring","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-30T16:17:59.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T13:32:32.740Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cedrickring.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-04-25T10:13:46.000Z","updated_at":"2024-07-30T16:18:03.000Z","dependencies_parsed_at":"2024-04-25T13:42:34.582Z","dependency_job_id":"9f0375b3-ab57-4ff4-8f57-5fb34b4de44c","html_url":"https://github.com/cedrickring/cora-deploy","commit_stats":{"total_commits":14,"total_committers":3,"mean_commits":4.666666666666667,"dds":0.2142857142857143,"last_synced_commit":"4a544fb5325c3a3004644ab78e602d3e36578b5c"},"previous_names":["cedrickring/cora-deploy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickring%2Fcora-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickring%2Fcora-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickring%2Fcora-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickring%2Fcora-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cedrickring","download_url":"https://codeload.github.com/cedrickring/cora-deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246443537,"owners_count":20778249,"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":[],"created_at":"2024-10-04T10:22:35.764Z","updated_at":"2026-01-07T23:46:25.541Z","avatar_url":"https://github.com/cedrickring.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cora Deployment\n\nThis repository contains the necessary files to run the Cora application using Docker and Docker Compose.\n\n## Pre-requisites\n\nMake sure to have the following tools installed:\n- [Docker](https://docs.docker.com/get-docker/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n## Configuring the application\n\nAfter cloning the repository, the application can be configured by altering the .env file in this repo. To create a new .env file, copy the .env.sample file and adjust the values accordingly.\n\n### OpenAI\nFor OpenAI you must set the following environment variables accordingly:\n\n```shell\nOPENAI_API_BASE=\"https://api.openai.com/v1\"\nOPENAI_API_KEY=\"\u003cYOUR_API_KEY\u003e\"\nOPENAI_EMBEDDINGS_MODEL=\"\u003cYOUR_EMBEDDINGS_MODEL\u003e\"\nOPENAI_GPT_MODEL=\"\u003cYOUR_GPT_MODEL\u003e\"\nBACKEND_URL=\"\u003cPUBLIC HOST OF BACKEND\u003e\"\n```\n\n### Azure OpenAI\nFor Azure OpenAI you must set the following environment variables accordingly:\n\n```shell\nOPENAI_API_BASE=\"\u003cYOUR_ENDPOINT\u003e\"\nOPENAI_API_KEY=\"\u003cYOUR_API_KEY\u003e\"\nOPENAI_EMBEDDINGS_MODEL=\"\u003cYOUR_EMBEDDINGS_MODEL\u003e\"\nOPENAI_GPT_MODEL=\"\u003cYOUR_GPT_MODEL\u003e\"\nBACKEND_URL=\"\u003cPUBLIC HOST OF BACKEND\u003e\"\n\n# Azure specific variables\nOPENAI_API_TYPE=\"azure\"\nAZURE_EMBEDDINGS_DEPLOYMENT=\"\u003cYOUR_EMBEDDINGS_DEPLOYMENT\u003e\"\nAZURE_GPT_MODEL_DEPLOYMENT=\"\u003cYOUR_GPT_MODEL_DEPLOYMENT\u003e\"\n\n```\n\n## Preprocessing the data\n\nBefore running the application, you need to preprocess the documents you want to ask questions against. The documents need to be put in `input_files/`. For now, we only support `.pdf` files.\n\nTo preprocess the documents, run the following command:\n```bash\ndocker compose run preprocessing\n```\n\nThis will preprocess the documents and store the results in the `vector_databases/` directory. As soon as the process is complete, you can continue with the next step: [Running the application](#running-the-application).\n\n**NOTE**: This process can take a few minutes depending on the amount and the size of the documents to process.\n\n## Running the application\n\nThis repository contains an automatically updated `compose.yaml` file that will pull the latest version of the Cora application and run it.\nIn addition to the autoconfiguration, you need to manually specify the environment variables specified in the `.env.sample` file. You can do this by copying the `.env.sample` file to `.env` and adjust the values accordingly.\n```bash\ncp .env.sample .env\n```\n\nAfter setting the environment variables, you can run the application using the following command:\n```bash\ndocker compose up -d\n```\n\n## Stopping the application\n\nTo stop the application, run the following command:\n```bash\ndocker compose down\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedrickring%2Fcora-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcedrickring%2Fcora-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedrickring%2Fcora-deploy/lists"}