Documentation: Include keys for contents of $service_secrets.env in $service.env #124

New Issue

Jafner · 2024-03-10T17:50:58-07:00

Jafner commented

2024-03-10 17:50:58 -07:00

Because the contents of our secrets env files are invisible in the repository, we should include comments in a visible env file to make clear the names of variables being passed into the container.

E.g. for zipline:

MFA_TOTP_ENABLED=true
WEBSITE_SHOW_FILES_PER_USER=true
WEBSITE_TITLE=Jafner.net
CORE_RETURN_HTTPS=false
CORE_HOST=0.0.0.0
CORE_PORT=3000
CORE_LOGGER=true
#CORE_DATABASE_URL # follows the structure: postgresql://[user[:password]@][host][/dbname]
#CORE_SECRET

Optionally, we can include comments about the structure or purpose of the variable, as seen above.

Because the contents of our secrets env files are invisible in the repository, we should include comments in a visible env file to make clear the names of variables being passed into the container. E.g. for zipline: ```env MFA_TOTP_ENABLED=true WEBSITE_SHOW_FILES_PER_USER=true WEBSITE_TITLE=Jafner.net CORE_RETURN_HTTPS=false CORE_HOST=0.0.0.0 CORE_PORT=3000 CORE_LOGGER=true #CORE_DATABASE_URL # follows the structure: postgresql://[user[:password]@][host][/dbname] #CORE_SECRET ``` Optionally, we can include comments about the structure or purpose of the variable, as seen above.

Sign in to join this conversation.

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Jafner/homelab#124