Skip to content

Commit

Permalink
clarify .env in install
Browse files Browse the repository at this point in the history
  • Loading branch information
rizen committed Mar 12, 2024
1 parent d348d9a commit f7a74a5
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,23 @@ cd my-cool-project
npm install
```

## Create your .env file
All of Ving's secrets and variables that can change in various environments like dev to prod are stored in a `.env` file in the root of your project. You can read more about [environment variables here](env).

Go ahead and create your `.env` file now and we'll add to it in the next few sections.

```bash
touch .env
```


## Redis
You'll need to [download and install Redis 7](https://redis.com/redis-enterprise-software/download-center/software/). Ving uses for the [cache](subsystems/cache), the [message bus](subsystems/messagebus), and the [jobs system](subsystems/jobs) subsystems.


### Create your .env file
### Update your .env file

Configuring Ving to use Redis is pretty simple. Just create an `.env` file in your project root and add a connection string that points to your Redis server:
Configuring Ving to use Redis is pretty simple. Just dd a connection string that points to your Redis server:

```bash
VING_REDIS="redis://localhost:6379"
Expand Down Expand Up @@ -101,7 +111,7 @@ flush privileges;
### Update your .env file

Update your `.env` in the project root and add your dev database connection string:
Update your `.env` to add your dev database connection string:

```bash
VING_MYSQL="mysql://mycooluser:mycoolpass@localhost:3306/mycoolproject"
Expand Down

0 comments on commit f7a74a5

Please sign in to comment.