74 Document using s3 vs filesystem locally #553
Conversation
Also add a note about some pre-requisites to running this application locally. closes cfpb#74
Coverage report
This PR does not seem to contain any modification to coverable code. |
| ### Pre-requisites | ||
| [SBL Project Repo](https://github.com/cfpb/sbl-project) contains the `docker-compose.yml` to run the ancillary services. | ||
| - Not all services need to run, this module `sbl-filing-api` is part of the docker compose file, which doesn't need to be ran in docker for local development. | ||
| - Issuing `docker compose up -d pg keycloak user-fi` would start the necessary services (regtech-user-fi-management, postgres, and keycloak) |
There was a problem hiding this comment.
A link to the sbl-project LOCAL_DEV_COMPOSE.md would be good here. We also use profiles so the backend profile pretty much does everything
There was a problem hiding this comment.
I added the link to the repo. Do you normally run the filing-api in docker locally during dev? I wasn't sure if that should be recommended or not since it is not necessary, although it does work as long as you have the project in a sibling folder to the sbl-project repo due to the build path in the compose file.
There was a problem hiding this comment.
Yeah normally don't run this outside of docker/k8s. Just thought it was a good idea to add the link since that read me has all the details for running pg, keycloak, also.
| export FS_UPLOAD_CONFIG__PROTOCOL="s3" | ||
| export FS_UPLOAD_CONFIG__ROOT="sbl-filing-api" | ||
| ``` | ||
| This can be made permanent by updating e.g. your `$HOME/.zshrc` file. |
There was a problem hiding this comment.
Not sure if you were thinking this goes hand in hand with the docker compose up above. If so, in sbl-project there is a filing.local.envthat is used by the container to load in env vars needed by the filing-api
There was a problem hiding this comment.
Actually here I was more thinking about running on the host, not in a container. Do you think it would be worth discussing all that here?
There was a problem hiding this comment.
I think it's worth mentioning just because normally we run in docker (though you can run it in poetry by itself... just rarely done). So a link to that env just as an FYI isn't bad
closes #74