Skip to content

Commit

Permalink
docs: env vars, todo
Browse files Browse the repository at this point in the history
  • Loading branch information
@mplewis
mplewis committed Nov 20, 2024
1 parent 73d296b commit 69f6d07
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion NOTES.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
- [ ] Captcha
- [ ] Discard changes
- [ ] Field length enforcement
- [ ] Fix disabled tests now that Markdown works
Expand Down Expand Up @@ -41,6 +40,7 @@
- [ ] Add pretty error messages for 404s (e.g. clicked an expired/tidied link)
- [ ] Redirect old slugs on slug change
- [ ] Site-wide announcement feature
- [x] Captcha
- [x] Hold RSVP locally with cookie
- [x] **Scheduler engine**
- [x] Send reminders
Expand Down
32 changes: 17 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,23 @@ Alias `rw` to make it easier to run commands: `alias rw='yarn redwood'`

Example values are provided in [.env.example](.env.example). Make a copy of that file named `.env`, then edit those values to set up your local development environment.

| Name | Type | Required? | Description |
| ------------------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| API_URL | string | | URL to the API server. When running locally, this should be `/.redwood/functions`. `redwood.toml` sets this to the Netlify value if unset. |
| DATABASE_URL | string | yes | The DB connection string which includes protocol, username, password, port, DB name, and options |
| DISCORD_WEBHOOK_URL | string | | If provided, send notifications for server events to this Discord channel via webhook |
| FROM_EMAIL | string | yes | The “from” address on outgoing emails |
| FROM_NAME | string | yes | The human-readable “from” name on outgoing emails |
| LOCAL_CHROMIUM | string | | Path to the Chromium binary, used to generate Open Graph event preview images |
| SENTRY_DSN | string | yes | DSN URL for your Sentry project, where errors are reported |
| SENTRY_ENV | string | no | Custom name reported for the environment for frontend Sentry errors. If unset, defaults to `process.env.NODE_ENV`. |
| SITE_HOST | string | yes | The hostname of your Freevite instance, used in absolute URLs (e.g. email content) |
| SMTP_HOST | string | yes | Hostname for your SMTP outgoing mail server |
| SMTP_PASS | string | yes | Password for your SMTP outgoing mail server |
| SMTP_USER | string | yes | Username for your SMTP outgoing mail server |
| TEST_DATABASE_URL | string | | The connection string for the DB instance used when running tests. If not provided, defaults to `./.redwood/test.db`. |
| Name | Type | Required? | Description |
| -------------------------------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| API_URL | string | | URL to the API server. When running locally, this should be `/.redwood/functions`. `redwood.toml` sets this to the Netlify value if unset. |
| DATABASE_URL | string | yes | The DB connection string which includes protocol, username, password, port, DB name, and options |
| DISCORD_WEBHOOK_URL | string | | If provided, send notifications for server events to this Discord channel via webhook |
| FROM_EMAIL | string | yes | The “from” address on outgoing emails |
| FROM_NAME | string | yes | The human-readable “from” name on outgoing emails |
| LOCAL_CHROMIUM | string | | Path to the Chromium binary, used to generate Open Graph event preview images |
| RECAPTCHA_SERVER_KEY | string | yes | [ReCAPTCHA](https://www.google.com/recaptcha) site key for the backend |
| REDWOOD_ENV_RECAPTCHA_CLIENT_KEY | string | yes | [ReCAPTCHA](https://www.google.com/recaptcha) site key for the frontend |
| REDWOOD_ENV_SENTRY_ENV | string | | Custom name reported for the environment for frontend Sentry errors. If unset, defaults to `process.env.NODE_ENV`. |
| SENTRY_DSN | string | yes | DSN URL for your Sentry project, where errors are reported |
| SITE_HOST | string | yes | The hostname of your Freevite instance, used in absolute URLs (e.g. email content) |
| SMTP_HOST | string | yes | Hostname for your SMTP outgoing mail server |
| SMTP_PASS | string | yes | Password for your SMTP outgoing mail server |
| SMTP_USER | string | yes | Username for your SMTP outgoing mail server |
| TEST_DATABASE_URL | string | | The connection string for the DB instance used when running tests. If not provided, defaults to `./.redwood/test.db`. |

# Contributions

Expand Down

0 comments on commit 69f6d07

Please sign in to comment.