wasp-lang/wasp
1
1
Fork 0
mirror of https://github.com/wasp-lang/wasp.git synced 2024-09-11 15:26:19 +03:00
Code Issues Projects Releases Wiki Activity

another doc update

Browse Source
This commit is contained in:
shayneczyzewski 2022-06-17 12:55:20 -04:00
parent 1827d2b8eb
commit 5bef1612ae
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
web/docs/deploying.md
View File

@ -30,16 +30,16 @@ Below we will explain the required env vars and also provide detailed instructio
### Env vars
Server uses following environment variables, so you need to ensure they are set on your hosting provider:
- `PORT` -> number of port at which it will listen for requests (e.g. `3001`).
- `DATABASE_URL` -> url to the Postgres database that it should use (e.g. `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`)
- `REACT_APP_URL` -> the URL of where the frontend app is running (e.g. `https://<app-name>.netlify.app`), which is used for CORS protection.
- `SESSION_COOKIE_SECRET` -> you need this if you are using Wasp's `auth` feature, which is used to sign cookies. Set it to a random string, at least 32 characters long.
- `PORT: int` -> number of port at which it will listen for requests (e.g. `3001`).
- `DATABASE_URL: string` -> url to the Postgres database that it should use (e.g. `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`).
- `REACT_APP_URL: string` -> the URL of where the frontend app is running (e.g. `https://<app-name>.netlify.app`), which is used for CORS protection.
- `SESSION_COOKIE_SECRET: string` -> you need this if you are using Wasp's `auth` feature, which is used to sign cookies. Set it to a random string, at least 32 characters long.
#### Optional env vars
- `SESSION_COOKIE_NAME` -> name of cookie used to store session data (defaults to `"wasp_session"`).
- `SESSION_COOKIE_MAX_AGE` -> max age of session cookie (defaults to `7` days).
- `CSRF_COOKIE_NAME` -> name of cookie used to store csrf double submit pattern secret (defaults to `"wasp_csrf"`).
- `TRUST_PROXY_COUNT` -> number of proxies for Express app to trust (defaults to `0` for dev, and `1` for prod).
- `SESSION_COOKIE_NAME: string` -> name of cookie used to store session data (defaults to `"wasp_session"`).
- `SESSION_COOKIE_MAX_AGE: int` -> max age of session cookie in milliseconds (defaults to one week).
- `CSRF_COOKIE_NAME: string` -> name of cookie used to store csrf double submit pattern secret (defaults to `"wasp_csrf"`).
- `TRUST_PROXY_COUNT: int` -> number of proxies for Express app to trust (defaults to `0` for dev, and `1` for prod).
### Deploying to Heroku
@ -60,9 +60,9 @@ heroku addons:create --app <app-name> heroku-postgresql:hobby-dev
```
Heroku will also set `DATABASE_URL` env var for us at this point. If you are using external database, you will have to set it yourself.
`PORT` env var will also be provided by Heroku, so the only thing left is to set the `SESSION_SECRET` env var and `REACT_APP_URL`:
`PORT` env var will also be provided by Heroku, so the only thing left is to set the `SESSION_COOKIE_SECRET` env var and `REACT_APP_URL`:
```
heroku config:set --app <app-name> SESSION_SECRET=<random_string_at_least_32_characters_long>
heroku config:set --app <app-name> SESSION_COOKIE_SECRET=<random_string_at_least_32_characters_long>
heroku config:set --app <app-name> REACT_APP_URL=<url_of_where_frontend_will_be_deployed>
```