-
-
Notifications
You must be signed in to change notification settings - Fork 5.3k
docs: Fix Heroku deploy button configuration #889
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -99,14 +99,18 @@ Configuration is located in `config.ts`. | |
|
|
||
| ## Heroku | ||
|
|
||
| [](https://heroku.com/deploy) | ||
| [](https://heroku.com/deploy?template=https://github.com/parse-community/parse-server-example) | ||
|
|
||
| The Heroku button uses `app.json` and asks for a `DATABASE_URI` during setup. Create a MongoDB database first, for example with [MongoDB Atlas](https://www.mongodb.com/atlas/database), then paste its connection string into the Heroku form. | ||
|
|
||
| Alternatively, to deploy manually: | ||
|
|
||
| * Clone the repo and change directory to it | ||
| * Log in with the [Heroku Toolbelt](https://toolbelt.heroku.com/) and create an app: `heroku create` | ||
| * Use the [mLab addon](https://elements.heroku.com/addons/mongolab): `heroku addons:create mongolab:sandbox --app YourAppName` | ||
| * Log in with the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) and create an app: `heroku create` | ||
| * Create a MongoDB database, for example with [MongoDB Atlas](https://www.mongodb.com/atlas/database), and copy its connection string | ||
| * Configure the database connection: `heroku config:set DATABASE_URI='<replace with MongoDB connection string>'` | ||
| * By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run `heroku config:set PARSE_MOUNT=/1` | ||
| * Configure the public server URL: `heroku config:set SERVER_URL=https://YourAppName.herokuapp.com/parse` | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed in the same commit — the README now adds an explicit |
||
| * Deploy it with: `git push heroku master` | ||
|
|
||
| ## AWS Elastic Beanstalk | ||
|
|
@@ -135,10 +139,10 @@ Detailed information is available here: | |
| 1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/). | ||
| 1. Setup a MongoDB server. You have a few options: | ||
| 1. Create a Google Compute Engine virtual machine with [MongoDB pre-installed](https://cloud.google.com/launcher/?q=mongodb). | ||
| 1. Use [mLab](https://mlab.com/google/) to create a free MongoDB deployment on Google Cloud Platform (only US-central). | ||
| 1. Use a hosted MongoDB service such as [MongoDB Atlas](https://www.mongodb.com/atlas/database). | ||
| 1. Modify `app.yaml` to update your environment variables. | ||
| 1. Delete `Dockerfile` | ||
| 1. Deploy it with `gcloud preview app deploy` | ||
| 1. Deploy it with `gcloud app deploy` | ||
|
|
||
| A detailed tutorial is available here: | ||
| [Running Parse server on Google App Engine](https://cloud.google.com/nodejs/resources/frameworks/parse-server) | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| { | ||
| "name": "Parse Server Example", | ||
| "description": "An example Parse API server using the parse-server module", | ||
| "repository": "https://github.com/ParsePlatform/parse-server-example", | ||
| "repository": "https://github.com/parse-community/parse-server-example", | ||
| "logo": "https://avatars0.githubusercontent.com/u/1294580?v=3&s=200", | ||
| "keywords": ["node", "express", "parse"], | ||
| "env": { | ||
|
|
@@ -17,11 +17,14 @@ | |
| "description": "A key that overrides all permissions. Keep this secret.", | ||
| "value": "myMasterKey" | ||
| }, | ||
| "DATABASE_URI": { | ||
| "description": "MongoDB connection string for this Parse Server deployment, for example a MongoDB Atlas connection string.", | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed in the same commit — |
||
| "required": true | ||
| }, | ||
| "SERVER_URL": { | ||
| "description": "URL to connect to your Heroku instance (update with your app's name + PARSE_MOUNT)", | ||
| "value": "http://yourappname.herokuapp.com/parse" | ||
| "description": "URL to connect to your Heroku instance (update with your app's name + PARSE_MOUNT).", | ||
| "value": "https://yourappname.herokuapp.com/parse" | ||
| } | ||
| }, | ||
| "image": "heroku/nodejs", | ||
| "addons": ["mongolab"] | ||
| "image": "heroku/nodejs" | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in the same commit — the README step for
DATABASE_URIdoesn't prescribe single quotes; it now says "quote or escape special characters as required by your shell", which leaves Windows / PowerShell users free to use their own syntax.