diff --git a/help/en/docs/images/azure-connect.png b/help/en/docs/images/azure-connect.png new file mode 100644 index 000000000..8bc7e139a Binary files /dev/null and b/help/en/docs/images/azure-connect.png differ diff --git a/help/en/docs/install/aws-marketplace.md b/help/en/docs/install/grist-builder-edition.md similarity index 54% rename from help/en/docs/install/aws-marketplace.md rename to help/en/docs/install/grist-builder-edition.md index 58592523f..79a383a24 100644 --- a/help/en/docs/install/aws-marketplace.md +++ b/help/en/docs/install/grist-builder-edition.md @@ -1,28 +1,48 @@ --- -title: AWS Marketplace +title: Grist Builder Edition --- -AWS Marketplace {: .tag-core .tag-ee } +Grist Builder Edition {: .tag-core .tag-ee } ============ +Grist Builder Edition is a virtual machine image offered for certain cloud providers. It has everything you need to run a self-hosted Grist instance with minimal setup. It can be found at the following locations: -[Grist Builder Edition](https://aws.amazon.com/marketplace/pp/prodview-tew3ygop5xxy4) on the AWS Marketplace has everything you need to run a self-hosted Grist instance with minimal setup. Below are the initial configuration steps. +* [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-tew3ygop5xxy4) +* [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/grist.grist-builder-edition) -### How to log in to the Grist instance +Once you select an offering, follow the usual procedure for each cloud provider for starting a virtual machine. You will need to allow SSH access for the virtual machine, as well as HTTP and HTTPS access. This corresponds to TCP network ports 22, 80, and 443 respectively. -During deployment, you should have been asked about creating or using key pairs. You can use this pair to log in via SSH from your terminal/bash. The default user for the Grist EC2 instance is named “ubuntu”, and you can log in to `ubuntu@[ec2-instance-public-ip]`. +### How to log in to the Grist instance -**Note:** You need to use the `*.pem` file you received while generating key pairs on AWS. Details about connecting via SSH can be found in the following places: +The Grist instance must be managed by SSH or equivalent console access. Details about connecting via SSH can be found in the following places: * Windows: [https://learn.microsoft.com/en-us/windows/terminal/tutorials/ssh](https://learn.microsoft.com/en-us/windows/terminal/tutorials/ssh) * Linux: [https://www.ssh.com/academy/ssh/command](https://www.ssh.com/academy/ssh/command) * macOS: [https://www.servermania.com/kb/articles/ssh-mac](https://www.servermania.com/kb/articles/ssh-mac) +Once you log in, follow the instructions displayed in the console. + +If you need some help with the initial configuration, read on below for some specific instructions for each cloud provider. + +#### AWS + +During deployment, you should have been asked about creating or using key pairs. You can use this pair to log in via SSH from yourf terminal/bash. The default user for the Grist EC2 instance is named “ubuntu”, and you can log in to `ubuntu@[ec2-instance-public-ip]`. + +**Note:** You need to use the `*.pem` file you received while generating key pairs on AWS. + If you don’t want to connect via SSH, AWS provides the option to connect from within the AWS console using the “Connect” button: ![AWS Connect screenshot](../images/aws-connect.png) -Once you log in, follow the instructions displayed in the console. +#### Azure + +When deploying the virtual machine you may be asked to use SSH keys or password, as well as the default user to log in as. The default user is named `azureuser`, and you can login as `azureuser@[azure-vm-public-ip]`. + +**Note:** If you choose to use default method of SSH keys, you need to use the `*.pem` file you received when Azure generated key pairs. + +There are other methods to connect. Click on the "Connect" tab in the virtual machine's sidebar in the Azure web portal if you need other options. + +![Azure connect screenshot](../images/azure-connect.png) ## Authentication setup diff --git a/mkdocs.yml b/mkdocs.yml index cadbf237e..0207b3f76 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -89,7 +89,7 @@ nav: - install/forwarded-headers.md - install/cloud-storage.md - install/grist-connect.md - - install/aws-marketplace.md + - install/grist-builder-edition.md - Audit logs: - install/audit-log-overview.md - install/audit-log-streaming.md @@ -215,6 +215,9 @@ plugins: enabled: !ENV [HTMLPROOFER_ENABLED, false] validate_external_urls: false - meta-descriptions + - redirects: + redirect_maps: + 'install/aws-marketplace.md': 'install/grist-builder-edition.md' markdown_extensions: toc: