|
1 |
| -# Magento 2.3.0 Magento Commerce (Cloud) |
| 1 | +# Magento 2.3.0 Magento Commerce Cloud |
2 | 2 |
|
3 |
| -This sample repository helps you deploy a Magento 2.3.0 Enterprise Edition (EE) instance in the cloud. You must be a licensed user of Magento Magento Commerce (Cloud) to use the example in this repository. |
| 3 | +This repository contains a sample Magento Commerce (on-premise) version 2.3.0 instance for you to deploy in the cloud. You must have an active Magento Commerce Cloud user license to use the example in this repository. |
4 | 4 |
|
5 |
| -This example is based on using the Composer to load dependencies and get the Magento vendor folders. |
| 5 | +The example requires the use of [Composer](https://getcomposer.org/doc/) to load and manage dependencies and Magento vendor folders. |
6 | 6 |
|
7 |
| -## Create an authorization file |
8 |
| -To enable you to install and update the Magento software, you must have an `auth.json` file in your project's root directory. `auth.json` contains your Magento EE [authorization credentials](http://devdocs.magento.com/guides/v2.2/install-gde/prereq/connect-auth.html). |
| 7 | +- [Authentication](#authentication) |
| 8 | + - [Authenticating in Docker](#authenticating-in-docker) |
| 9 | +- [Repository structure](#repository-structure) |
| 10 | +- [Developer documentation](#developer-documentation) |
9 | 11 |
|
10 |
| -In some cases, you might already have `auth.json` so check to see if it exists and has your authentication credentials before you create a new one. |
| 12 | +## Authentication |
11 | 13 |
|
12 |
| -To create a new `auth.json` in the event you don't have one: |
| 14 | +You must have an authentication key to access the Magento Commerce repository and to enable install and update commands for your Magento Commerce Cloud project. |
| 15 | +The following method is best to prevent accidental exposure of credentials, such as pushing an `auth.json` file to a public repository. If you plan to use Docker for your local development, then jump to the [Authenticating in Docker](#authenticating-in-docker) section. |
13 | 16 |
|
14 |
| -1. Copy the provided sample using the following command: |
| 17 | +To add authentication keys using an environment variable: |
15 | 18 |
|
16 |
| - cp auth.json.sample auth.json |
17 |
| -2. Open `auth.json` in a text editor. |
18 |
| -3. Replace `<public-key>` and `<private-key>` with your authentication credentials. |
| 19 | +1. In the _Project Web UI_, click the configuration icon in the upper left corner. |
19 | 20 |
|
20 |
| - See the following example: |
| 21 | +1. In the _Configure Project_ view, click the **Variables** tab. |
21 | 22 |
|
22 |
| - "http-basic": { |
23 |
| - "repo.magento.com": { |
24 |
| - "username": "<public-key>", |
25 |
| - "password": "<private-key>" |
26 |
| - } |
| 23 | +1. Click **Add Variable**. |
| 24 | + |
| 25 | +1. In the _Name_ field, enter `env:COMPOSER_AUTH`. |
| 26 | + |
| 27 | +1. In the _Value_ field, add the following and replace `<public-key>` and `<private-key>` with your Magento Commerce Cloud authentication credentials. |
| 28 | + |
| 29 | + ```json |
| 30 | + { |
| 31 | + "http-basic": { |
| 32 | + "repo.magento.com": { |
| 33 | + "username": "<public-key>", |
| 34 | + "password": "<private-key>" |
| 35 | + } |
| 36 | + } |
| 37 | + } |
| 38 | + ``` |
| 39 | + |
| 40 | +1. Select **Visible during build** and deselect **Visible at run**. |
| 41 | + |
| 42 | +1. Click **Add Variable**. |
| 43 | + |
| 44 | +See [Adding Magento authentication keys](https://devdocs.magento.com/guides/v2.2/cloud/setup/first-time-setup-import-prepare.html#auth-json). |
| 45 | + |
| 46 | +### Authenticating in Docker |
| 47 | + |
| 48 | +You must have an `auth.json` file that contains your Magento Commerce authorization credentials in your Magento Commerce Cloud root directory. |
| 49 | + |
| 50 | +1. Using a text editor, create an `auth.json` file and save it in your Magento root directory. |
| 51 | + |
| 52 | +1. Replace <public-key> and <private-key> with your Magento Commerce authentication credentials. |
| 53 | + |
| 54 | + ```json |
| 55 | + { |
| 56 | + "http-basic": { |
| 57 | + "repo.magento.com": { |
| 58 | + "username": "<public-key>", |
| 59 | + "password": "<private-key>" |
27 | 60 | }
|
28 |
| -3. Save your changes to `auth.json` and exit the text editor. |
| 61 | + } |
| 62 | + } |
| 63 | + ``` |
| 64 | + |
| 65 | +1. Save your changes to `auth.json` file and exit the text editor. |
| 66 | + |
| 67 | +To use Docker for local development, see [Launching a Docker configuration](https://devdocs.magento.com/guides/v2.2/cloud/docker/docker-config.html). |
29 | 68 |
|
30 | 69 | ## Repository structure
|
31 |
| -Here are the specific files for this example to work on Magento Magento Commerce (Cloud): |
32 | 70 |
|
33 |
| -``` |
| 71 | +The following is a list of the specific files required for this example to work in the Magento Commerce Cloud: |
| 72 | + |
| 73 | +```bash |
34 | 74 | .magento/
|
35 |
| - /routes.yaml |
36 |
| - /services.yaml |
| 75 | + /routes.yaml |
| 76 | + /services.yaml |
37 | 77 | .magento.app.yaml
|
38 | 78 | auth.json
|
39 | 79 | composer.json
|
40 | 80 | magento-vars.php
|
41 | 81 | php.ini
|
42 | 82 | ```
|
43 | 83 |
|
44 |
| -`.magento/routes.yaml` redirects `www` to the naked domain, and that the application that will be serving HTTP is named `php`. |
45 |
| - |
46 |
| -`.magento/services.yaml` sets up a MySQL instance, plus Redis and Solr. |
47 |
| - |
48 |
| -``composer.json`` fetches the Magento Enterprise Edition and some configuration scripts to prepare your application. |
| 84 | +- `.magento/routes.yaml`—redirects `www` to the naked domain and `php` application to serve HTTP. |
| 85 | +- `.magento/services.yaml`—sets up a MySQL instance, including Redis and ElasticSearch. |
| 86 | +- `composer.json`—fetches the Magento Enterprise Edition and configuration scripts to prepare your application. |
49 | 87 |
|
50 |
| -## Documentation |
51 |
| -For more details, see our [Magento Enterprise Cloud Guide](http://devdocs.magento.com/guides/v2.2/cloud/bk-cloud.html). |
| 88 | +## Developer documentation |
52 | 89 |
|
| 90 | +See the [Magento Commerce Cloud Guide](http://devdocs.magento.com/guides/v2.2/cloud/bk-cloud.html). |
0 commit comments