Skip to content

Commit 70fa565

Browse files
docs: Adds default env
1 parent 4e03c35 commit 70fa565

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,30 @@ This is Jay's Timeseries API server. It requires a Timescale DB instance.
44

55
## Getting Started
66

7-
Create a `.env` file in this directory that contains necessary environment variables. For example:
7+
Create a `.env` file in this directory that contains necessary environment variables. Defaults:
88

99
```
10-
USERNAME=<username>
11-
PASSWORD=<password>
12-
API_KEY=<apikey>
13-
14-
HOST=<host>
15-
PORT=<port>
16-
JWT_SECRET=<password>
17-
18-
DATABASE_HOST=<host>
19-
DATABASE_PORT=<port>
20-
DATABASE_USERNAME=<username>
21-
DATABASE_PASSWORD=<password>
22-
DATABASE_NAME=<name>
10+
USERNAME=
11+
PASSWORD=
12+
API_KEY=
13+
14+
HOST=localhost
15+
PORT=80
16+
JWT_SECRET=
17+
18+
DATABASE_HOST=localhost
19+
DATABASE_PORT=5432
20+
DATABASE_USERNAME=postgres
21+
DATABASE_PASSWORD=postgres
22+
DATABASE_NAME=postgres
23+
24+
CURRENT_STORE_TYPE=memory # Options: redis, memory
25+
REDIS_ADDRESS=localhost:6379
26+
REDIS_PASSWORD=
27+
REDIS_DATABASE=0
28+
29+
MQTT_ADDRESS=
30+
MQTT_USERNAME=
31+
MQTT_PASSWORD=
2332
```
2433

0 commit comments

Comments
 (0)