Skip to content

Commit 8594eab

Browse files
committed
Minor cosmetic adjustments.
1 parent 0339f09 commit 8594eab

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ This repo is not installable via `npm`. Instead, Github provides a handy "Use th
3434
| Variable | DEV default | PROD default | Description
3535
|------------|----------------------|-------------------------|----------------------
3636
| ASSETS_URL | "" (empty string) | "" (empty string) | Webpack is configured to modify static asset URLs to point to a CDN, like CloudFront. MUST end with a slash " / ".
37-
| BASE_URL | raw:https://my‑api.app | raw:https://my‑api.app | The address of the Sails instance.
38-
| DB_HOST | localhost | localhost | The hostname of the datastore.
39-
| DB_USER | root | produser | Username for the datastore.
40-
| DB_PASS | mypass | myprodpassword | Password for the datastore.
41-
| DB_NAME | myapp | proddatabase | The name of the database inside the datastore.
42-
| DB_PORT | 3306 | 3306 | The port number for datastore.
43-
| DB_SSL | false | false | If the datastore requires SSL, set this to "true".
37+
| BASE_URL | https://myapi.app | https://myapi.app | The address of the Sails instance.
38+
| DB_HOST | localhost | localhost | The hostname of the datastore.
39+
| DB_USER | root | produser | Username for the datastore.
40+
| DB_PASS | mypass | myprodpassword | Password for the datastore.
41+
| DB_NAME | myapp | proddatabase | The name of the database inside the datastore.
42+
| DB_PORT | 3306 | 3306 | The port number for datastore.
43+
| DB_SSL | false | false | If the datastore requires SSL, set this to "true".
4444

4545
## Request Logging
4646
Automatic incoming request logging, is a 2 part process. First, the [`request-logger` hook](api/hooks/request-logger.js) gathers info from the request, and creates a new [`RequestLog` record](api/models/RequestLog.js), making sure to mask anything that may be sensitive, such as passwords. Then, a custom response gathers information from the response, again, scrubbing sensitive data (using the [customToJSON](https://sailsjs.com/documentation/concepts/models-and-orm/model-settings?identity=#customtojson) feature of Sails models) to prevent leaking of password hashes, or anything else that should never be publicly accessible. The [`keepModelsSafe` helper](api/helpers/keep-models-safe.js) and the custom responses (such as [ok](api/responses/ok.js) or [serverError](api/responses/serverError.js)) are responsible for the final leg of request logs.

config/env/development.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
module.exports = {
1414
logSensitiveData: false, // never log sensitive data in remote development database
1515

16-
baseUrl: process.env.BASE_URL || 'https://my-api.app',
17-
assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with /
16+
baseUrl: process.env.BASE_URL || 'https://myapi.app',
17+
assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with / or be blank.
1818

1919
/***************************************************************************
2020
* Set the default database connection for models in the development *

config/env/production.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ module.exports = {
2323

2424
logSensitiveData: false, // never log sensitive data in production database
2525

26-
baseUrl: process.env.BASE_URL || 'https://my-api.app',
27-
assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with /
26+
baseUrl: process.env.BASE_URL || 'https://myapi.app',
27+
assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with / or be blank.
2828

2929
/**************************************************************************
3030
* *

0 commit comments

Comments
 (0)