env vars stub

mitre · Nov 27, 2024 · 82c5e9b · 82c5e9b
1 parent f88d182
commit 82c5e9b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -1,6 +1,6 @@
 # Vulcan Configuration
 
-Vulcan can be set up in a few different ways. It can be done by having a vulcan.yml file that has settings for many different configurations. If there is no vulcan.yml file then the configurations will be read in from vulcan.default.yml that has default configuration as well as the ability for the configurations to be set by environment variables.
+Vulcan can be set up in a few different ways. It can be done by having a vulcan.yml file that has settings for many different configurations. If there is no vulcan.yml file then the configurations will be read in from vulcan.default.yml that has default configuration as well as the ability for the configurations to be set by environment variables (see [installation](index.md)).
 
 [**Installation**](index.md) | [**Configuration**](config.md)
 

diff --git a/docs/index.md b/docs/index.md
@@ -8,6 +8,7 @@ Vulcan can be set up in a few different ways. It can be done by having a vulcan.
 * [Dependencies](#dependencies)
 * [Run with Docker](#run-with-docker)
 * [Tasks](#tasks)
+* [Environment Variables](#environment-variables)
 
 ## Installation
 
@@ -28,6 +29,7 @@ Given that Vulcan requires at least a database service, we use Docker Compose.
 3. Navigate to the base folder where `docker-compose.yml` is located
 4. Run the following commands in a terminal window from the vulcan source directory:
    1. `./setup-docker-secrets.sh`
+      ([environment variables](#environment-variables) should be set beforehand)
    2. `docker-compose up -d`
    3. `docker-compose run --rm web rake db:create db:schema:load db:migrate`
    4. `docker-compose run --rm web rake db:create_admin`
@@ -92,4 +94,7 @@ bundle exec rails stig_and_srg_puller:pull
 You can set the frequency of this task according to your preference or needs. However, it's important to consider the volume of data being pulled
 and the impact on the application's performance when deciding on the frequency.
 
-Please refer to your hosting platform's documentation or support services for specific instructions on how to set up scheduled tasks or cron jobs.
+Please refer to your hosting platform's documentation or support services for specific instructions on how to set up scheduled tasks or cron jobs.
+
+## Environment Variables
+