From 118232e9065c00b11e96341b69eed1384e8b07d6 Mon Sep 17 00:00:00 2001 From: hackerESQ Date: Sun, 26 Jan 2025 21:50:25 -0600 Subject: [PATCH] update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ce9a81f..529bdf5 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,13 @@ Ready? Let's get started! Grab a copy of the [Docker Compose](https://github.com/investbrainapp/investbrain/blob/main/docker-compose.yml) file and paste the contents where you plan to install Investbrain. -**2. Copy [.env](https://github.com/investbrainapp/investbrain/blob/main/.env.example)** +**2. Set your environment** -Copy over the [.env.example](https://github.com/investbrainapp/investbrain/blob/main/.env.example) file to the same directory as the compose file you created above. +Adjust the `environment` property in the Docker Compose file to your preferences. -> Don't forget: You need to set the `APP_KEY` value in your .env! If you're unsure, you can run `openssl rand -base64 32` from your terminal to generate a strong key! +Particularly, you need to set the `APP_KEY` value for your environment. If you're unsure, you can run `openssl rand -base64 32` from your terminal to generate a strong key. + +> Tip: Want to know what options are available? You can reference the [.env.example](https://github.com/investbrainapp/investbrain/blob/main/.env.example) file in this respository for available environment configurations. **3. Run `docker compose up`**