doc/api-details: environment variables for Redis and Database

Add instructions for adding variables for redis host and database URL configuration to `.env` file. Signed-off-by: Jeny Sadadia <[email protected]>
kernelci · Aug 12, 2023 · 5fb6819 · 5fb6819
1 parent 2d0e7a8
commit 5fb6819
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api-details.md b/doc/api-details.md
@@ -26,6 +26,14 @@ default to None.  If a user wants to change any of the above variables, they
 should be added to the .env file.
 
 
+### Configure Redis and Mongo
+
+By default, API uses Redis and Database services specified in [`docker-compose.yaml`](https://github.com/kernelci/kernelci-api/blob/main/docker-compose.yaml).
+API is configured to use redis hostname `redis` and database service
+URL `mongodb://db:27017` at the moment.
+In case of using different services or configurations, `REDIS_HOST` and `MONGO_SERVICE` variables should be added to .env file.
+
+
 ## Users
 
 `User` model objects can be created from a terminal or using `/user` endpoint.