You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
# To enable this plugin, add to your '_config.local.yml' the following:
7
+
#
8
+
# debug: site_post_render
9
+
#
10
+
# This plugin runs an IRB session (https://github.com/ruby/irb) of a Jekyll application in a serving mode when it's at a state after rendering the whole site, but before writing any files.
11
+
# See the ":site, :post_render" hook: https://jekyllrb.com/docs/plugins/hooks/
12
+
# Available objects to explore are 'site' and 'payload'.
13
+
#
14
+
# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
15
+
# - '.methods.sort'
16
+
# - '.instance_variables.sort'
17
+
# - '.keys.sort'
18
+
#
19
+
# Examples:
20
+
#
21
+
# To view available configuration data of the site
# To enable this plugin, add to your '_config.local.yml' the following:
7
+
#
8
+
# debug: site_pre_render
9
+
#
10
+
# This plugin runs an IRB session (https://github.com/ruby/irb) of a Jekyll application in a serving mode when it's at a state just before rendering the whole site.
11
+
# See the ":site, :pre_render" hook: https://jekyllrb.com/docs/plugins/hooks/
12
+
# Available objects to explore are 'site' and 'payload'.
13
+
#
14
+
# Several helpful methods (to use a method, chain to an object such as 'site.methods', 'payload.keys'):
15
+
# - '.methods.sort'
16
+
# - '.instance_variables.sort'
17
+
# - '.keys.sort'
18
+
#
19
+
# Examples:
20
+
#
21
+
# To view available configuration data of the site
Copy file name to clipboardExpand all lines: src/_includes/cloud/enable-ssh.md
+38-82Lines changed: 38 additions & 82 deletions
Original file line number
Diff line number
Diff line change
@@ -15,89 +15,31 @@ For more information on SSH keys, see the following:
15
15
16
16
## Locate an existing SSH key pair {#existing}
17
17
18
-
An existing SSH key pair is typically located in the `.ssh` subdirectory of the user's home directory. This folder is hidden and may not display in the file manager or finder unless configured to display hidden files and folders.
19
-
20
-
You can quickly verify if you have SSH keys by entering commands using terminal access.
21
-
22
-
To check for SSH keys, enter the following command:
23
-
24
-
```bash
25
-
ls ~/.ssh
26
-
```
27
-
28
-
If you have SSH keys, a directory listing is displayed similar to the following:
29
-
30
-
```terminal
31
-
id_rsa id_rsa.pub known_hosts
32
-
```
33
-
34
-
If you do not have SSH keys, you need to generate the keys for adding to your Magento ECE account and GitHub account. See [Create a new SSH key pair](#ssh-create-new-key-pair).
35
-
36
-
If you already have SSH keys, continue to:
37
-
38
-
-[Add a public SSH key to your Magento account](#ssh-add-to-account) section
39
-
-[Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
40
-
41
-
## Create a new SSH key pair {#ssh-create-new-key-pair}
42
-
43
-
Use the `ssh-keygen` command to create an SSH key pair. `ssh-keygen` is typically installed on Linux systems.
18
+
An existing SSH key pair is typically located in the `.ssh` subdirectory of the user home directory. This folder is hidden and may not display in the File Manager or Finder if your system is not configured to display hidden files and folders.
44
19
45
20
{:.procedure}
46
-
To create an SSH key pair:
21
+
To check for SSH keys:
47
22
48
-
1.The command syntax follows, entering the email used for your GitHub account:
23
+
1.In the terminal, list the contents of your SSH directory.
49
24
50
25
```bash
51
-
ssh-keygen -t rsa
26
+
ls ~/.ssh
52
27
```
53
28
54
-
GitHub also uses the key length `-b 4096` in the command. Follow the prompts to complete the key.
55
-
56
-
1. When prompted to "Enter a file in which to save the key," press **Enter** to save the file to the default location. The prompt displays the location.
57
-
58
-
1. When prompted to enter a secure passphrase, enter a phrase to use like a password. Make note of this passphrase. You may be requested to enter it depending on tasks you complete using a terminal during development.
29
+
1. Review the output.
59
30
60
-
1. After creating the SSH key pair, start the ssh-agent:
31
+
If you have SSH keys, a directory listing is displayed similar to the following:
61
32
62
-
For Mac or Linux:
63
-
64
-
```bash
65
-
eval"$(ssh-agent -s)"
33
+
```terminal
34
+
id_rsa id_rsa.pub known_hosts
66
35
```
67
36
68
-
For Mac, you can edit the `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
69
-
70
-
```conf
71
-
Host *
72
-
AddKeysToAgent yes
73
-
UseKeychain yes
74
-
IdentityFile ~/.ssh/id_rsa
75
-
```
37
+
If the directory does not exist or has no SSH key files, you must generate at least one SSH key and add it to your GitHub account. For instructions, see [Generate a new SSH key](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) in the GitHub documentation.
76
38
77
-
{:.bs-callout-info}
78
-
You can specify multiple SSH keys by adding multiple `IdentityFile` entries to your configuration.
39
+
If you have at least one SSH key in your directory, add the key to your Magento and GitHub accounts:
79
40
80
-
For Windows:
81
-
82
-
```shell
83
-
eval$(ssh-agent -s)
84
-
```
85
-
86
-
1. Add the SSH key to the ssh-agent. If you used a different name for the key file name, replace `id_rsa` with that file name.
87
-
88
-
For Mac:
89
-
90
-
```bash
91
-
ssh-add -K ~/.ssh/id_rsa
92
-
```
93
-
94
-
For Windows or Linux:
95
-
96
-
```shell
97
-
ssh-add ~/.ssh/id_rsa
98
-
```
99
-
100
-
1.[Add your SSH key to your GitHub account.](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) The instructions include Mac, Windows, and Linux.
41
+
-[Add an SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
42
+
-[Add your public SSH key to your Magento account](#ssh-add-to-account)
101
43
102
44
### Test the SSH keys {#test}
103
45
@@ -120,13 +62,14 @@ You can add SSH keys to your account in any of the following ways:
120
62
- Using the [{{site.data.var.ece}} CLI](#add-key-cli)
121
63
- Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
122
64
123
-
### Add a key using the CLI {#add-key-cli}
65
+
### Add your SSH key using the CLI {#add-key-cli}
124
66
125
67
{:.procedure}
126
68
To add an SSH key using the CLI:
127
69
128
70
1. Open a terminal application on your local workstation.
129
-
1. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ site.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
71
+
72
+
1. If you have not done so already, log in (or switch to) the [Magento file system owner]({{ site.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
130
73
131
74
1. Log in to your project:
132
75
@@ -140,30 +83,43 @@ To add an SSH key using the CLI:
140
83
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
141
84
```
142
85
143
-
### Add a key using the Project Web Interface {#add-key-web}
86
+
{:.bs-callout-tip}
87
+
You can list and delete SSH keys using the Magento Cloud CLI commands `ssh-key:list` and `ssh-key:delete`.
144
88
145
-
You will select and add your SSH public key to each environment in your account.
89
+
### Add your SSH key using the Project Web Interface {#add-key-web}
90
+
91
+
You must add your SSH public key to your account. After you add the key, you must redeploy all active environments on your account to install the key.
146
92
147
93
- Starter: Add to Master (Production) and any environments you create by branching from Master
148
-
- Pro: Add the key to Staging, Production, and Integration environments
94
+
- Pro: Add the key to the Staging, Production, and Integration environments
149
95
150
96
{:.procedure}
151
-
To add an SSH key using the Project Web Interface:
97
+
To add an SSH key using the Project Web interface:
98
+
99
+
1. Get your public key.
152
100
153
-
1. Copy your SSH public key to the clipboard.
101
+
- In the terminal, navigate to the `~/.ssh` directory.
154
102
155
-
If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them.
103
+
- Copy the contents of the public key file `~/.ssh/<keyname>.pub` to the clipboard.
104
+
105
+
If there are no SSH key files in the directory, you must create one. See [Generate a new SSH key](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) in the GitHub documentation.
156
106
157
107
1. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
158
-
1. In your selected branch, an icon displays if you do not have an SSH key added.
108
+
109
+
1. In your project, look for the **No SSH key** icon to the right of the command field. This icon is visible when the project does not contain an SSH key.
- Follow the prompts on your screen to complete the task.
165
120
166
-
1. Follow the prompts on your screen to complete the task.
121
+
{:.bs-callout-tip}
122
+
You can view and manage the SSH keys on your account in _Account settings_. In the upper right corner of the Project Web interface, click **your-user-name** > **Account Settings**.
Copy file name to clipboardExpand all lines: src/cloud/cdn/cloud-vcl-custom-snippets.md
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,9 @@ You can create and manage custom VCL snippets from the Magento Admin UI or by us
45
45
46
46
-[Magento Admin UI](#manage-custom-vcl-snippets-from-the-magento-admin-ui)—We recommend using the Magento Admin UI to manage custom VCL snippets because it automates the process to validate and upload the custom snippet and apply your changes to the Fastly service configuration. Additionally, you can view and edit the custom VCL snippets added to the Fastly service configuration from the Admin UI.
47
47
48
+
{:.bs-callout-info}
49
+
You must use the Fastly API to [delete custom VCL snippets](https://devdocs.magento.com/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl), or you can delete the contents of the snippet in the Magento Admin UI and upload an empty snippet. See [Delete a custom snippet](https://devdocs.magento.com/cloud/cdn/fastly-vcl-badreferer.html#delete-the-custom-vcl-snippet).
50
+
48
51
-[Fastly API](#manage-custom-vcl-snippets-using-the-api)—Manage custom VCL snippets using the API if you cannot access the Magento Admin UI. For example, if the site is down and you need to troubleshoot the Fastly service configuration or add a custom VCL snippet. Additionally, some operations can only be completed using the API, for example reactivating an older VCL version or viewing all the VCL snippets included in a specified the VCL version. See [API quick reference for VCL snippets](#manage-vcl).
By default, the TLS container is included with the Docker Compose configuration. However, you can generate a configuration without TLS by adding the `--no-tls` option to the `ece-docker build:compose` command.
222
+
221
223
The TLS termination proxy container facilitates the Varnish SSL termination over HTTPS.
222
224
223
225
- The default port for TLS communication is `443`.
The Web container uses NGINX to handle web requests after TLS and Varnish. This container passes all requests to the FPM container to serve the PHP code. See [Request flow]({{site.baseurl}}/cloud/docker/docker-containers.html#request-flow).
269
271
272
+
This container provides two NGINX configuration options for building the Docker configuration:
273
+
274
+
- `--nginx-worker-processes`to set the number of worker processes for NGINX. The default is `1`.
275
+
- `--nginx-worker-connections`to set the maximum number of connections that each worker process can handle simultaneously. The default is `1024`.
276
+
270
277
The NGINX configuration for this container is the standard Magento [nginx config], which includes the configuration to auto-generate NGINX certificates for the container. You can customize the NGINX configuration by mounting a new configuration file using a volume.
0 commit comments