- Download the WAR file
- Set up your VCN
- Upload BuildVu WAR file
- Install Docker
- Pull and run idrsolutions/buildvu
- HTTPS Integration [Optional]
- Environment variables
- Running BuildVu from different language clients
One of the easiest ways to deploy BuildVu on Oracle Cloud Infrastructure is to run a single compute instance and installing docker on it.
Before getting started, you first want to download the WAR file. This is required for the image to work.
For trial users:
If you haven’t already, sign up for BuildVu trial.
Open the email you recieve when you signed up.
Follow the download link found in the Docker section.
Visit the Customer download page.
Click on ‘Download Latest Customer WAR’.
Submit your username and password.
Start by navigating to Virtual Cloud Networks (VCN).
Create a VCN (use the wizard if uncertain).
Once complete, open your VCN.
Select “Security Lists”.
Open the default list for your VCN.
Click on “Add Ingress Rules” and copy the settings below.
Click “Add Ingress Rules” and navigate to compute/Instances.
Click “Create Instance” and follow the network settings below.
Make sure to add the SSH key you will need to connect to the instance to continue, click create and open our preferred method for SSH connections. (I will be using bash.)
"ssh -i key opc@" where key is the directory of the private key followed by your instance’s public IP e.g.
ssh -i instance.key firstname.lastname@example.org
Once connected, type the following commands waiting in turn for each to complete.
In a seperate terminal, you will need to upload the WAR file with scp.
Using the same ssh details, the command will look like:
scp -i <key> <path/to/buildvu-microservice.war> opc@<instance public IP>:/home/opc
scp -i instance.key buildvu-microservice.war email@example.com:/home/opc
This will upload to the opc home directory; ready for use with docker.
sudo yum install docker-engine
sudo docker pull idrsolutions/buildvu
If you get the following message then you will need to run another command to start the docker deamon:
sudo service docker start
Now launch the docker image.
sudo docker run -p 80:80 --mount "source=/home/opc/buildvu_microservice.war,target=/usr/local/tomcat/webapps/ROOT.war,type=bind" idrsolutions/buildvu
Now go to a web browser and enter the public IP of your instance followed by “:80” to connect e.g.
22.214.171.124:80. You should be shown a page displaying the name of the service being used, in this case “BuildVu Microservice Example”.
If you intend to use HTTPS encryption, you will need to update your VNS security list.
Navigate back to VNS and create a new ingress rule with the following settings:
Using the same key used to update the war file add your certificate, key, and ca_bundle. They should have these names:
scp -i <key> <path/to/certificate.crt> opc@<instance public IP>:/home/ssl/certificate.crt scp -i <key> <path/to/private.key> opc@<instance public IP>:/home/ssl/private.key scp -i <key> <path/to/ca_bundle.crtr> opc@<instance public IP>:/home/ssl/ca_bundle.crt
Now run the following command to start the service:
docker run -p 80:80 -p 443:443 --mount "source=/home/opc/buildvu_microservice.war,target=/usr/local/tomcat/webapps/ROOT.war,type=bind" --mount "source=/local/path/to/ssl/directory,target=/opt/ssl,type=bind,readonly" idrsolutions\buildvu
If you encounter an error then you may need to run the following command instead. Please take caution in doing this - more information can be found in the docker docs.
docker run -p 80:80 -p 443:443 --mount "source=/home/opc/buildvu_microservice.war,target=/usr/local/tomcat/webapps/ROOT.war,type=bind" --volume "/path/to/ssl"/target:"/opt/ssl"/app:z,ro idrsolutions/buildvu
There are a few useful environment variables that you can use.
These are used to set a username and password to access the microservice:
- ACCESS_USERNAME: used to set a username for the microservice.
- ACCESS_PASSWORD: used to set a password for the microservice.
Now that you have the docker server running you can follow the tutorials for using the API to begin your conversions.
Still need help? Send us your questions.