Skip to content

Commit 936a89b

Browse files
authored
Instruct users to create their own .env.sample file with their specific details.
1 parent 1a51e9f commit 936a89b

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@ services:
3333
POSTGRES_USER: warpSQLUser
3434
POSTGRES_PASSWORD: warpSQLPass
3535
```
36+
# Environment Variables
37+
38+
This project requires certain environment variables to be set for proper configuration. These variables include sensitive information such as database credentials. To securely manage these variables, we follow a specific approach.
39+
Ensure that you have a `.env.sample` file same directory as the `docker-compose.yml` file.
40+
Open the `.env.sample` file in a text editor.
41+
Provide placeholders for the required environment variables in the `.env.sample` file. Do not include any actual sensitive information in this file. Here's an example of how the `.env.sample` file should look:
42+
43+
```
44+
POSTGRES_USER=
45+
POSTGRES_PASSWORD=
46+
```
47+
Replace `POSTGRES_USER` and `POSTGRES_PASSWORD` with the appropriate variable names specific to your project.
48+
Save the `.env.sample` file.
49+
Before running the project, create a new file named `.env` in the same directory as the `docker-compose.yml` file.
50+
Open the `.env` file and provide the actual values for the environment variables, specific to your setup. For example:
51+
`POSTGRES_USER=myuser`
52+
`POSTGRES_PASSWORD=mypassword`
53+
54+
Replace myuser and mypassword with the actual values you want to use.
55+
Save the `.env` file. Ensure that this file is not committed to version control to protect your sensitive information.
3656

3757
WarpSQL is a powerful solution that provides opinionated extensions to Postgres, conveniently packaged as a single Docker deployment. It eliminates the need to install multiple separate databases by offering a comprehensive set of features in one place (although not everything, as some features might not be included).
3858

0 commit comments

Comments
 (0)