Andras/BoundlessFlowCampus2K

Fork 0

Document secrets/.env usage #281

New issue

Closed

opened 2026-04-14 09:15:29 +00:00 by a24vinla · 5 comments

a24vinla commented

2026-04-14 09:15:29 +00:00

Collaborator

We need to create a wiki page documenting how, why and when to use the secrets/.env file for those who haven't used it previously, since it hasn't been brought up much in our program.

Add documentation to this wiki page: Secrets and .env.
Feel free to change name of wiki page.

Parent Issue: #11
Related Issue: #239

We need to create a wiki page documenting how, why and when to use the secrets/.env file for those who haven't used it previously, since it hasn't been brought up much in our program. Add documentation to this wiki page: [Secrets and .env](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Secrets-and-.env). Feel free to change name of wiki page. Parent Issue: #11 Related Issue: #239

a24vinla added the

project documentation

label

2026-04-14 09:15:29 +00:00

j21marbr was assigned by c24elipe

2026-04-14 09:21:10 +00:00

j21marbr commented

2026-04-14 16:33:41 +00:00

Collaborator

The documentation has been added to wiki

j21marbr added the

needs review

label

2026-04-14 16:34:08 +00:00

b24krila was assigned by b24johka

2026-04-15 14:56:15 +00:00

b24krila commented

2026-04-15 15:25:57 +00:00

Collaborator

However an issue is that the page basically only contains information on how it works and is used. So the page would benefit from explaining why we are using this approach and When we should use it. This will hopefully help make the page slightly more beginner-friendly and easier to understand for developers who may not be familiar with .env.

The structure is clear and follows a logical flow through out the document. With steps explaining what a .env file is and then explaining how it works within the project. this makes the content easy to follow and understand. However an issue is that the page basically only contains information on **how** it works and is used. So the page would benefit from explaining **why** we are using this approach and **When** we should use it. This will hopefully help make the page slightly more beginner-friendly and easier to understand for developers who may not be familiar with .env.

b24krila removed the

needs review

label

2026-04-15 15:26:02 +00:00

j21marbr commented

2026-04-20 10:20:09 +00:00

Collaborator

Why use an .env file
We use an .env file to separate configuration values from the code.

This keeps sensitive data out of the code
It improves security since the values are not pushed to the repository
It allows for flexibility as values can be updated without changing the code

When to use .env file

An .env file can be used when working with credentials or other sensitive data.
It's also useful when values need to change between different environments e.g when each developer uses their own local configuration.

Why use an .env file We use an .env file to separate configuration values from the code. - This keeps sensitive data out of the code - It improves security since the values are not pushed to the repository - It allows for flexibility as values can be updated without changing the code When to use .env file - An .env file can be used when working with credentials or other sensitive data. - It's also useful when values need to change between different environments e.g when each developer uses their own local configuration.

j21marbr added the

needs review

label

2026-04-20 10:20:47 +00:00

j21marbr commented

2026-04-20 10:21:35 +00:00

Collaborator

I will update wiki with this when the review is done

b24krila commented

2026-04-20 10:32:01 +00:00

Collaborator

Great job.

The update clearly addresses the missing context from the original documentation. And the page now clearly explains what an .env file is, how it works, why its used and when to use it.

Therefore I believe that the documentation is now complete and fit for use.

Great job. The update clearly addresses the missing context from the original documentation. And the page now clearly explains what an .env file is, **how it works, why its used and when to use it.** Therefore I believe that the documentation is now complete and fit for use.

b24krila added

reviewed

and removed

needs review

labels

2026-04-20 10:32:13 +00:00

a24vinla closed this issue

2026-04-20 11:06:38 +00:00