Installation on Vagrant
The Yombo Gateway software can be installed using Vagrant on Linux, Windows, or MacOS. This creates a VirtualBox instance where the Yombo Gateway software, and its dependencies, are installed and configured. This is perfect for isolation, development, or when running on Windows or Mac.
Vagrant is an open-source software product for building and maintaining virtual software development environments. VirtualBox is open-source software that runs a virtual machine on your computer.
If you are setting up Vagrant for develop or contribute to Yombo Gateway: Follow the Setup Development Environment guide instead.
The root yombo-gateway will be mirrored to the /yombo-gateway directory on the guest virtual machine. Additionally, the working directory (where Yombo Gateway stores the database, configuration files, and more) will be mapped to yombo-gateway/virtualization/vagrant/working_dir.
You'll need to fork the Yombo Gateway repository and install some software to get going.
If you don't have git, be sure to install GIT too.
Next, download the Yombo Gateway source code. From the directory you wish to install the software:
Download the source code:
$ git clone https://github.com/yombo/yombo-gateway.git
Working with Vagrant
When running the provision script or running the vagrant command, be sure you are in the yombo-gateway/virtualization/vagrant directory.
Create the Vagrant VM
This will download the Ubuntu image and start the VirtualBox and internally start the installation process of Yombo Gateway requirements. This process might take up to 30 to 40 minutes, depending on internet speed and workstation resources. After the installation is complete, you can access the web interface from the local computer using http://localhost:18080 or using the public ip address (which will be shown when the process is complete).
$ cd yombo-gateway/virtualization/vagrant $ ./provision.sh setup
$ cd yombo-gateway/virtualization/vagrant $ ./provision.bat setup
To get various status of the machine, such as IP address and URLs:
$ ./provision.sh status
Windows (this feature hasn't been implemented yet):
$ ./provision.bat status
Starting / Stopping Guest
To start the guest:
$ ./provision.sh start
$ ./provision.bat start
To stop it:
$ ./provision.sh stop
$ ./provision.bat stop
Connecting to guest
To connect to the guest, use on of the following:
This must be performed within the 'yombo-gateway/virtualization/vagrant' directory:
$ vagrant ssh
From the 'yombo-gateway/virtualization/vagrant' directory, find the IP address of the guest:
$ ./provision.bat status
Look for the line that states "Network IP Address". You'll use this IP address to connect to the machine. The username and password is vagrant. The below example assumes an IP address of 192.168.1.200 as reported by the vagrant status command.:
$ ssh email@example.com