VM Install : Azure
How to install OpenSquiggly on an Azure virtual machine.
Overview of Installing on Azure
We’ve provided a quick setup script that makes it easy to configure your disk space and install dependencies on a virtual machin in Microsoft Azure.
In this document, you’ll complete the following steps:
- Create a Virtual Machine
- Configure the VM for SSH Access
- Download the OpenSquiggly zip file and run the setup script
- Perform post-installation testing by creating an account, logging in, and create some quick content to verify the instance is working
Part 1 : Creating a Virtual Machine
Steps to Complete
- Visit your Azure Portal at https://portal.azure.com and login to your Azure account.
- In the search box, search for “virtual machine”, and select Virtual Machines from the list.
- Click the Create button near the top left portion of the portal, and choose the Azure virtual machine from the dropdown list.
- Under the Basics tab, fill in the desired parameters for the VM:
- Subscription
- Resource Group
- Enter a Virtual machine name
- For image type, choose Ubuntu Server 20.04 LTS - Gen2
- Pick a Size for the VM. A Standard_D2s_v3 should be sufficient for a basic OpenSquiggly installation with up to 100 users
- Fill in other parameters based on your security preferences
- We recommend leaving the SSH public key radio button selected
- Click the Create button to start the provisioning process.
- Download the private key using the popup window that will appear.
- Go to the newly created VM resource, go to the Disks section, and add an Azure Disk. See below video for more details.
Video
Part 2 : Enabling SSH Access to the VM
Steps to Complete
- Copy the downloaded SSH key into your ~/.ssh folder
cd ~/.ssh cp ~/Downloads/file_name_here.pem . chmod 400 file_name_here.pem
- Test the SSH access with:
ssh -o "IdentitiesOnly=yes" -i ~/.ssh/file_name_here.pem azureuser@VM.IP.ADDRESS.HERE
- Create an alias in your .bashrc file to make it easier to SSH:
echo alias ssh_vm=\'ssh -o "IdentitiesOnly=yes" -i ~/.ssh/file_name_here.pem azureuser@VM.IP.ADDRESS.HERE\' >> ~/.bashrc source ~/.bashrc
- Test your SSH alias
ssh_vm
Video
Part 3 : Running the Setup Script
Steps to Complete
- SSH into the VM
ssh_vm
- Change to the /opt folder
cd /opt
- Install unzip
sudo apt update sudo apt install unzip
- Retrieve the Application Files. Visit the OpenSquiggly website at https://opensquiggly.com for the latest download instructions which have have changed since this document was published.
sudo wget http://files.opensquiggly.com/opensquiggly.latest.zip
- Unzip the file
sudo unzip opensquiggly.latest.zip -d OpenSquiggly
- Change to the /opt/OpenSquiggly/setup folder
cd /opt/OpenSquiggly/setup
- Invoke the setup script.
sudo bash azure-setup.sh
- Follow the setup instructions and enter the information when prompted. Please see the video below for additional guidance.
Video
Part 4 : Post-Installation Testing
- From your browser, navigate to the IP address DNS address where you VM is registered.
- Click the “Create account” button and create a new account.
- Login with your login id and password.
- Enter some content in the home page.
- Enter a search phrase in the search bar and hit
. Verify that the correct page(s) are returned. - Mount one or more repositories and graft them into your document tree.
- Try searching for some content in your repositories to verify that the search is working.
- Experiment with the Navigator to arrange your document tree to your liking.