Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dockerizing Ragbot for Ease of Installation #15

Open
rajivpant opened this issue Jun 9, 2024 · 0 comments
Open

Dockerizing Ragbot for Ease of Installation #15

rajivpant opened this issue Jun 9, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@rajivpant
Copy link
Owner

Is your feature request related to a problem? Please describe.

Yes, currently Ragbot requires users to install all the dependencies and set up the environment manually. This can be time consuming, error prone, and a barrier for some users. Dockerizing Ragbot would make it much easier to get up and running quickly in a standardized environment.

Describe the solution you'd like

I would like to add a Dockerfile to the Ragbot repository that defines the required environment and dependencies. This Dockerfile can then be used to build a Docker image containing everything needed to run Ragbot.

Additionally, documentation should be added explaining how to build the Docker image and run Ragbot using Docker. Ideally a docker-compose file would also be provided to make it easy to spin up any additional services Ragbot may need.

The goal is for a user to be able to have Ragbot up and running just by cloning the repo and running a simple docker run or docker-compose up command.

Describe alternatives you've considered

An alternative is to continue with the current approach of providing setup instructions for users to follow. However, this doesn't address the root issue of simplifying and standardizing the setup process.

Another option could be providing pre-built executables or packages for different platforms. But this would be more work to create and maintain compared to a single Dockerfile.

Additional context

Some key things to consider when creating the Dockerfile:

  • It should be based on a lightweight Python base image
  • It needs to install any OS-level and Python dependencies
  • It should copy the Ragbot code into the image
  • The Ragbot config file and profiles should be easy to customize, perhaps by mounting them as volumes
  • Consider security best practices, such as not running as root
  • Ensure the image is optimized to be as small as possible
@rajivpant rajivpant added the enhancement New feature or request label Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant