From 46351370f06a3c5329bfe6af7ac88f8ee160d22a Mon Sep 17 00:00:00 2001 From: hackerESQ Date: Wed, 4 Sep 2024 19:32:23 -0500 Subject: [PATCH] add config options --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df81c03..384bcf4 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ And bring up the container (this will take a few minutes): docker composer up ``` +In the previous setep, all of the default configurations are set. This includes creating a .env file and setting the required `APP_KEY`. + If everything worked as expected, you should now be able to access Investbrain in the browser at: ```bash @@ -36,9 +38,15 @@ http://localhost:8000/register Congrats! You've just installed Investbrain! +## Configuration + +There are several available configuration options when installing with the recommended [Docker method](#Installation). These options are configurable using an environment file, and you can see which options are configurable by reviewing the [docker-compose.yml](https://github.com/investbrainapp/investbrain/blob/main/docker-compose.yml) file. Changes can be made in the [.env.example](https://github.com/investbrainapp/investbrain/blob/main/.env.example) file before installation. + +If you make any updates to the default configurations, make sure you restart the Docker containers in order for those changes to take effect. + ## Updating -To update Investbrain using the recommended Docker installation method, you just need to stop the running containers: +To update Investbrain using the recommended [Docker installation](#Installation) method, you just need to stop the running containers: ```bash docker compose stop