Skip to content

Commit c840b81

Browse files
author
Son NK
committedJan 23, 2020
rename .env.example to example.env
1 parent a934a8c commit c840b81

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed
 

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you have Docker installed, run the following command to start SimpleLogin loc
5656
```bash
5757
docker run -it --rm \
5858
-e RESET_DB=true \
59-
-e CONFIG=/code/.env.example \
59+
-e CONFIG=/code/example.env \
6060
-p 7777:7777 \
6161
simplelogin/app:1.0.0 python server.py
6262
```
@@ -288,7 +288,7 @@ Finally, restart Postfix
288288
289289
### Run SimpleLogin Docker containers
290290

291-
To run the server, you need a config file. Please have a look at [config example](./.env.example) for an example to create one. Some parameters are optional and are commented out by default. Some have "dummy" values, fill them up if you want to enable these features (Paddle, AWS, etc).
291+
To run the server, you need a config file. Please have a look at [config example](example.env) for an example to create one. Some parameters are optional and are commented out by default. Some have "dummy" values, fill them up if you want to enable these features (Paddle, AWS, etc).
292292

293293
Let's put your config file at `~/simplelogin.env`.
294294

@@ -415,18 +415,18 @@ Then make sure all tests pass
415415
pytest
416416
```
417417

418-
To run the code locally, please create a local setting file based on `.env.example`:
418+
To run the code locally, please create a local setting file based on `example.env`:
419419

420420
```
421-
cp .env.example .env
421+
cp example.env .env
422422
```
423423

424424
Make sure to uncomment the `RESET_DB=true` to create the database locally.
425425

426426
Feel free to custom your `.env` file, it would be your default setting when developing locally. This file is ignored by git.
427427

428428
You don't need all the parameters, for example, if you don't update images to s3, then
429-
`BUCKET`, `AWS_ACCESS_KEY_ID` can be empty or if you don't use login with Github locally, `GITHUB_CLIENT_ID` doesn't have to be filled. The `.env.example` file contains minimal requirement so that if you run:
429+
`BUCKET`, `AWS_ACCESS_KEY_ID` can be empty or if you don't use login with Github locally, `GITHUB_CLIENT_ID` doesn't have to be filled. The `example.env` file contains minimal requirement so that if you run:
430430

431431
```
432432
python3 server.py

‎.env.example ‎example.env

File renamed without changes.

0 commit comments

Comments
 (0)
Please sign in to comment.