Skip to content

Commit ed7351a

Browse files
committed
Updated README
1 parent 7758ca5 commit ed7351a

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

‎README.md‎

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,34 @@ Head over to [cookiecutter-flask](https://github.com/sloria/cookiecutter-flask)
1212

1313
## Docs
1414

15-
### Environment Variables
15+
### Database
1616

17+
Use linked postgres or mysql/mariadb container for automated db configuration.
18+
See fig.yml in repo for example.
1719

20+
Otherwise use DB_URI or DB_*. DB_URI takes precedence:
1821

19-
# Environment Variables
22+
## Environment Variables
2023

2124
| Section | Variable Name | Default | Details |
2225
| --- | --- | --- | --- |
23-
| Server | --- | --- | --- |
24-
| --- | SERVER_NAME | '_' | Nginx 'server_name' directive. |
25-
26-
## Mail
27-
28-
* MAIL_SERVER
29-
* MAIL_PORT
30-
* MAIL_TLS
31-
* MAIL_SSL
32-
* MAIL_USER
33-
* MAIL_PASS
34-
* MAIL_SENDER
35-
36-
## DB
37-
38-
Use linked postgres or mysql/mariadb container for automated db configuration.
39-
Otherwise use DB_URI or DB_*. DB_URI takes precedence:
40-
41-
* DB_URI : Specify whole URI in one environment variable
42-
* DB_USER
43-
* DB_PASS
44-
* DB_ADDR
45-
* DB_PORT
46-
* DB_TYPE : Optional if DB port is standard mysql (3306) or postgres (5432) port
26+
| Server | | | |
27+
| | SERVER_NAME | '_' | Nginx 'server_name' directive. |
28+
| Mail | | | |
29+
| | MAIL_SERVER | | SMTP server |
30+
| | MAIL_PORT | 587 | Port |
31+
| | MAIL_TLS | true | Use TLS for communication with mail server |
32+
| | MAIL_SSL | false | Use SSL for communication with mail server |
33+
| | MAIL_USER | admin | Login username for SMTP server |
34+
| | MAIL_PASS | | Login password for SMTP server |
35+
| | MAIL_SENDER | admin@example.com | Email address to send mail from |
36+
| DB | | | |
37+
| | DB_URI | | Specify whole URI in one environment variable |
38+
| | DB_USER | | Login user for DB |
39+
| | DB_PASS | | Password for user@db |
40+
| | DB_ADDR | | domain or IP of DB |
41+
| | DB_PORT | | Port of DB |
42+
| | DB_TYPE | | Type of database, 'mysql' or 'postgresql'. Optional if DB port is standard mysql (3306) or postgres (5432) port |
4743

4844
## Flask
4945
* CREATE_FLASK_DB : use `python manage.py ...` commands to make databases with SQLAlchemy. Defaults to `false`. Set to `true` to enable.

0 commit comments

Comments
 (0)