yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-13 16:08:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

further simplified the docs to use mongodb atlas

Browse Source
This commit is contained in:
davidkartuzinski 2019-07-18 17:54:34 +02:00
parent 6ddb30f9ee
commit 29ccc79a68
2 changed files with 34 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/3.0.0-beta.x/guides/databases.md
View File

@ -269,27 +269,13 @@ MongoDB Atlas automatically exposes the database credentials into a single envir
- Under `1. Choose your driver version`, select **DRIVER** as `Node.js` and **VERSION** as `2.2.12 or later`. **IMPORTANT:** You **must** use `Version: 2.2.12 or later`. - Under `1. Choose your driver version`, select **DRIVER** as `Node.js` and **VERSION** as `2.2.12 or later`. **IMPORTANT:** You **must** use `Version: 2.2.12 or later`.
- This should show a **Connection String Only** similar to this: - This should show a **Connection String Only** similar to this:
`mongodb://paulbocuse:<password>@strapi-heroku-shard-00-00-o777o.mongodb.net:27017,strapi-heroku-shard-00-01-o606o.mongodb.net:27017,strapi-heroku-shard-00-02-o606o.mongodb.net:27017/test?ssl=true&replicaSet=Strapi-Heroku-shard-0&authSource=admin&retryWrites=true&w=majority` `mongodb://paulbocuse:<password>@strapi-heroku-shard-00-00-oxxxo.mongodb.net:27017,strapi-heroku-shard-00-01-oxxxo.mongodb.net:27017,strapi-heroku-shard-00-02-oxxxo.mongodb.net:27017/test?ssl=true&replicaSet=Strapi-Heroku-shard-0&authSource=admin&retryWrites=true&w=majority`
- You are interested in everything **BETWEEN** the `@` symbol and `&w=majority`. This is your database **"host":** variable. So in this case: **IMPORTANT:** Please note the `<password>` after your `username`. In this example, after `mongodb://paulbocuse:`. You will need to replace the `<password>` with the password you created earlier for this user in your **MongoDB Atlas** account.
**NOT THIS PART:** `mongodb://paulbocuse:<password>@` 5. Update and replace your existing `/database.json` config file for the appropriate environment (development | production).
**JUST THIS PART:** Replace the contents of `/database.json` with the following and replace **< password >** with the password of the user of your database you created earlier:
`strapi-heroku-shard-00-00-o777o.mongodb.net:27017,strapi-heroku-shard-00-01-o606o.mongodb.net:27017,strapi-heroku-shard-00-02-o606o.mongodb.net:27017/test?ssl=true&replicaSet=Strapi-Heroku-shard-0&authSource=admin&retryWrites=true`
**NOT THIS PART:** `&w=majority`
::: warning WARNING
When you copy the URL as above, ensure to delete the `&w=majority` after `...=true`. If you leave this in the string it will **not** connect.
:::
- You created earlier a `username` and `password`, within your **MongoDB Atlas** account for connecting to databases. These are the **"username":** and **"password:"** variables needed to configure your project and connect to MongoDB Atlas.
5. Update and replace your existing `/database.json` config file for the appropriate environment (development|production).
Replace the contents of `/database.json` with the following AND replace the **"host":**, **"username"**: and **"password:"** with the credentials to your account:
`Path: ./config/environments/(development|production)/database.json`. `Path: ./config/environments/(development|production)/database.json`.
@ -300,10 +286,7 @@ Replace the contents of `/database.json` with the following AND replace the **"h
"default": { "default": {
"connector": "strapi-hook-mongoose", "connector": "strapi-hook-mongoose",
"settings": { "settings": {
"host": "cluster0-shard-00-00-y8imj.mongodb.net:27017,cluster0-shard-00-01-y8imj.mongodb.net:27017,cluster0-shard-00-02-y8imj.mongodb.net:27017/test?ssl=true&replicaSet=Cluster0-shard-0&authSource=admin&retryWrites=true", "uri": "mongodb://paulbocuse:<password>@strapidatabase-shard-00-00-fxxx6c.mongodb.net:27017,strapidatabase-shard-00-01-fxxxc.mongodb.net:27017,strapidatabase-shard-00-02-fxxxc.mongodb.net:27017/test?ssl=true&replicaSet=strapidatabase-shard-0&authSource=admin&retryWrites=true&w=majority"
"port": 27017,
"username": "[THE USERNAME YOU CREATED ABOVE IN THE MONGODB ATLAS ACCOUNT]",
"password": "[THE PASSWORD YOU CREATED ABOVE IN THE MONGODB ATLAS ACCOUNT]"
}, },
"options": { "options": {
"ssl": true "ssl": true
@ -313,4 +296,16 @@ Replace the contents of `/database.json` with the following AND replace the **"h
} }
``` ```
::: warning Note
The above configuration will create a database called `test`, the default database for **MongoDB Atlas**. If you would like to name your database something else, add the following **key:value pair** into your **"settings":** in your `database.json` file.
`"database": "my-database-name",`
:::
::: danger Warning
We recommend replacing sensitive (eg. "URI string" above) information in your database.json files before uploading your project to a public repository such as GitHub. For more information about using environment variables, please read [dynamic configurations](https://strapi.io/documentation/3.0.0-beta.x/configurations/configurations.html#dynamic-configurations).
:::
You are now ready use Strapi locally or to deploy your project to an external hosting provider and use MongoDB Atlas as your database server. You are now ready use Strapi locally or to deploy your project to an external hosting provider and use MongoDB Atlas as your database server.

32
docs/3.0.0-beta.x/guides/deployment.md
View File

@ -1218,7 +1218,7 @@ Init the Git repository and commit yoru project.
cd my-project cd my-project
git init git init
git add . git add .
git commit -am "Initial Commit" git commit -m "Initial Commit"
``` ```
### 6. Create a Heroku project ### 6. Create a Heroku project
@ -1343,22 +1343,25 @@ npm install pg --save
Please follow these steps the **deploy a Strapi app with MongoDB on Heroku**. Please follow these steps the **deploy a Strapi app with MongoDB on Heroku**.
You must have completed the [steps to use Strapi with MongoDB Atlas](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas). You must have completed the [steps to use Strapi with MongoDB Atlas](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas) - through **4. Retrieve database credentials**.
##### 1. Set environment variables ##### 1. Set environment variables
When you [set-up your MongoDB Atlas database](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas) you created and noted the three key/value pairs that correspond to your **MongoDB Atlas** database. These three keys are: `DATABASE_USERNAME`, `DATABASE_PASSWORD`, and `DATABASE_HOST`. You should haWhen you [set-up your MongoDB Atlas database](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas) you noted a connection string. Similar to this:
Strapi expects a variable for each database connection detail (host, username, etc.). So, from **MongoDB Atlas**, you have to set the environment variables in the Heroku config (for **DATABASE_HOST** you need to surround the URL with **""**, and set **DATABASE_PORT** to nothing):
```bash ```bash
heroku config:set DATABASE_USERNAME=paulbocuse mongodb://paulbocuse:<password>@strapidatabase-shard-00-00-fxxx6c.mongodb.net:27017,strapidatabase-shard-00-01-fxxxc.mongodb.net:27017,strapidatabase-shard-00-02-fxxxc.mongodb.net:27017/test?ssl=true&replicaSet=strapidatabase-shard-0&authSource=admin&retryWrites=true&w=majority
heroku config:set DATABASE_PASSWORD=mySecretPassword
heroku config:set DATABASE_HOST="stapi-mongo-heroku-shard-00-00-fty6c.mongodb.net:27017,strapi-mongo-heroku-shard-00-01-fty6c.mongodb.net:27017,strapi-mongo-heroku-shard-00-02-fty6c.mongodb.net:27017/test?ssl=true&replicaSet=strapi-mongo-heroku-shard-0&authSource=admin&retryWrites=true"
heroku config:set DATABASE_PORT=
``` ```
**Note:** Please replace these above values with the your actual values. So, from **MongoDB Atlas**, you have to set two environment variables in the Heroku config (for **DATABASE_URI** and **DATABASE_NAME**). Set the environment variables using the following commands:
```bash
heroku config:set DATABASE_URI="mongodb://paulbocuse:<password>@strapidatabase-shard-00-00-fxxx6c.mongodb.net:27017,strapidatabase-shard-00-01-fxxxc.mongodb.net:27017,strapidatabase-shard-00-02-fxxxc.mongodb.net:27017/test?ssl=true&replicaSet=strapidatabase-shard-0&authSource=admin&retryWrites=true&w=majority"
heroku config:set DATABASE_NAME="my-database-name"
```
**Note:** Please replace the `<password>` and `my-database-name` values with the your actual values.
##### 2. Update your database config file ##### 2. Update your database config file
@ -1373,10 +1376,8 @@ Replace the contents of `database.json` with the following:
"default": { "default": {
"connector": "strapi-hook-mongoose", "connector": "strapi-hook-mongoose",
"settings": { "settings": {
"host": "${process.env.DATABASE_HOST}", "uri": "${process.env.DATABASE_URI}",
"port": "${process.env.DATABASE_PORT}", "database": "${process.env.DATABASE_NAME}"
"username": "${process.env.DATABASE_USERNAME}",
"password": "${process.env.DATABASE_PASSWORD}"
}, },
"options": { "options": {
"ssl": true "ssl": true
@ -1393,7 +1394,8 @@ Replace the contents of `database.json` with the following:
`Path: ./my-project/` `Path: ./my-project/`
```bash ```bash
git commit -am "Update database config" git add .
git commit -m "Update database config"
``` ```
### 9. Deploy ### 9. Deploy