burr icon indicating copy to clipboard operation
burr copied to clipboard

feat: add docker and nginx support

Open 97k opened this issue 1 year ago • 0 comments

[Short description explaining the high-level reason for the pull request] api.localhost will direct to api on port 7242 and telemetry.localhost will open the Burr UI

Changes

  • add Docker support along with compose file
  • nginx as a proxy for api and burr UI
  • bug fixes

How I tested this

Tested the docker build

Notes

Checklist

  • [x] PR has an informative and human-readable title (this will be pulled into the release notes)
  • [x] Changes are limited to a single goal (no scope creep)
  • [x] Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • [x] Any change in functionality is tested
  • [x] New functions are documented (with a description, list of inputs, and expected output)
  • [x] Placeholder code is flagged / future TODOs are captured in comments
  • [ ] Project documentation has been updated if adding/changing functionality.

[!IMPORTANT] Adds Docker and Nginx support for email assistant with proxy configuration and minor server updates.

  • Docker and Nginx Support:
    • Adds Dockerfile to set up a Python environment and run wrapper.sh.
    • Adds docker-compose.yaml to define services for the app and Nginx, exposing ports 7241 and 7242.
    • Adds nginx.conf to proxy api.localhost to port 7242 and telemetry.localhost to port 7241.
  • FastAPI Server:
    • Adds root endpoint in server.py to return a welcome message.
    • Includes router with prefix /email_assistant in server.py.
  • Miscellaneous:
    • Fixes type hint bug in _run_through() in server.py.
    • Adds wrapper.sh to start Burr UI and FastAPI server.

This description was created by Ellipsis for 54a77358465740284c0c70a4148efb431218e47a. It will automatically update as commits are pushed.

97k avatar Oct 11 '24 20:10 97k