Closed Bug 877214 Opened 12 years ago Closed 11 years ago

Update README to summarize important session variables that are in `env.dist`

Categories

(Webmaker Graveyard :: Thimble, defect)

x86
macOS
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: bobby, Assigned: michiel)

Details

Attachments

(1 file)

Thimble's README needs to describe the session variables which are required for deployment, especially when using S3 and/or heroku. Currently, LOGINAPI, SESSION_SECRET, and S3 credentials aren't mentioned, but they exist in `env.dist`. If these variables are absent when attempting to deploy to heroku, wild nasty cryptic errors appear! ``` 2013-05-29T15:49:59.054293+00:00 app[web.1]: url.js:118 2013-05-29T15:49:59.059382+00:00 app[web.1]: at module.exports (/app/node_modules/webmaker-loginapi/index.js:24:23) 2013-05-29T15:49:59.056929+00:00 app[web.1]: throw new TypeError("Parameter 'url' must be a string, not " + typeof url) 2013-05-29T15:49:59.057075+00:00 app[web.1]: ^ 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Object.<anonymous> (/app/app.js:30:44) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Module._compile (module.js:456:26) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Url.parse (url.js:118:11) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Function.Module._load (module.js:312:12) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Function.Module.runMain (module.js:497:10) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Object.Module._extensions..js (module.js:474:10) 2013-05-29T15:49:59.059382+00:00 app[web.1]: TypeError: Parameter 'url' must be a string, not undefined 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Object.urlParse [as parse] (url.js:112:5) 2013-05-29T15:49:59.059673+00:00 app[web.1]: at startup (node.js:119:16) 2013-05-29T15:49:59.059382+00:00 app[web.1]: at Module.load (module.js:356:32) ``` Maybe those should be cleaned up as well, i.e. display human-friendly errors.
I'll update the README with the required environment variables. Good catch, sorry that I forgot to keep the docs in sync.
Status: NEW → ASSIGNED
Attachment #755437 - Flags: review?(bobby)
Thanks! Left some comments in the pull request.
fixed and new pull filed.
Looks good! r+
Attachment #755437 - Flags: review?(bobby) → review+
landed.
Status: ASSIGNED → RESOLVED
Closed: 11 years ago
Resolution: --- → FIXED
Attachment mime type: text/plain → text/x-github-pull-request
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: