Description
This component is responsible for managing SSH access to the instance.
Settings
There are 2 key considerations here based on who you wish to provide access to your instances. If you are the company owner, most senior developer or internal team, then you can automatically add yourselves as SSH authorised users to all new instances - therefore you can add your keys to the parent instance all instances will inherit these keys. If you just wish to provide SSH access to individual instances then you can setup keys on a per instance basis.
| Setting | Description | Live Connector | Production | Development | Release Candidate |
|---|---|---|---|---|---|
| Enable | Whether SSH should be enabled. | Y | Y | Y | Y |
| Production Identities | SSH identities to be used for production (see SSH Identities) | Y | |||
| Production Identities - Use same for development | If enabled the same identities will be used for development instances. If you want to use different identities for development instance uncheck this. (This can be useful if you want to give junior developers SSH access to development instances, but not production) | Y | |||
| Development Identities | SSH identities to be used for development instances (see SSH Identities). | Y | |||
| Identities | SSH identities to be used for development instances (see SSH Identities). | Y | Y | Y | |
| Host | It cannot be changed and is just here for informative purposes (if you are going to be SSH'ing directly to the instance). It displays the SSH host as well as the port SSH is running on in the format host:port. |
Y | Y | Y | |
| Username | It cannot be changed and is just here for informative purposes (if you are going to be SSH'ing directly to the instance). | Y | Y | Y |
N.B MDOQ only supports SSH access using SSH keys. If you are unsure what an SSH key is or how to generate one, Github have some great documentation, see here.
N.B For Live connector instances, settings will only effect development instances, MDOQ can't enable/disable SSH for your production site.
SSH Identities
- name
This has no effect on ssh, it is just there to help identify keys. Each name must be unique other wise it will be overwritten. - public key
This is the public part of your SSH key (usually ending with.pub, e.g:~/.ssh/id_rsa.pub)
We would recommend generating an SSH key specifically for MDOQ.
Recreation
Recreating this component simply re-applies the configured credentials if it is enabled.
MDOQ SSH Environment
Regardless of the method used to SSH into your instance the environment will be the same.
- Terminal prompt
The terminal prompt is the bit of text before the flashing cursor. e.g: It contains 3 useful pieces of information; current user, current instance and current directory.
In the formatUSERNAME@HOST:CURRENT_DIRECTORY$this allows you to quickly see your current situation. - Project root
Depending on the platform you are SSH'd into the project direct is different- Magento 1 or 2:
/home/magento/htdocs, to get here quickly once you've logged in run the command:cd ~/htdocs/ - Vue Storefront Frontend or Backend: '/var/www'.
- Magento 1 or 2:
- Root Access
There is no root access on the instances, if you really need to run a command as root (such as install programs that aren't installed) see PHP-FPM post roll up actions.