- Updating on-premises software
- Upgrading JOAN's firmware
- Network Configuration for the Virtual Machine
- Change the Docker default subnet IP address
- Change the Docker-compose default IP address
- Change the Visionect Software Suite password
- System requirements
- Install Visionect Software Suite without the VM
Companies and organizations may wish to keep the key aspects of managing JOAN in the house. In this case, you can decide to have the thin client JOAN device run on your own, on-premises server infrastructure, where device management and connectivity is offloaded to a local server to reduce the load on our core server infrastructure and provide you with a higher level of control over devices.
On-premises hosting is ideal for either customers that do not want to use the Software as a Service (SaaS) approach or for customers that have an established in-house IT department and probably already run a number of internal servers. Deploying JOAN on your own server infrastructure will require advanced IT skills, as well as some experience with server deployment and management.
When JOAN is hosted on-premises, both the server setup and maintenance falls to you. This also means that, apart from your initial investment, no additional monthly charges will be incurred when connecting JOAN to the online calendar you are using. No worries: you will be able to switch from on-premises to the cloud at any time.
Installing JOAN on on-premises servers
To install JOAN on your own server infrastructure, you will need to run a virtual machine on your servers that will allow JOAN to connect to the calendars you are using.
Packaging the server in the Virtual Machine is an industry standard approach. We support VirtualBox, VMware and Hyper-V, which are the standard in the industry and – based on customer feedback – the preferred way of deploying in business environments.
The virtual machine is based on Ubuntu 14.04 LTS x64 and uses the Visionect Software Suite software to provide connectivity to the devices. The virtual machine requires network connectivity to the JOAN Portal, where you will manage your devices.
Deploy JOAN on your servers in the following steps:
1. Check that your infrastructure meets the requirements
You will require a hypervisor that is capable of running virtual machines. This can either be a consumer oriented (VMware Workstation, VirtualBox) or server oriented solution (ESXi, Hyper-V).
The virtual machine you’ll be running is 64-bit, so you’ll need a computer with VT-X support. We suggest using two cores for the virtual machine and at least 4GB of memory. The absolute minimum for one device is 1.5GB, with every additional device using up to 220MB. You’ll need about 2 GB of hard drive space to install, but there will be some logs and history stored on the virtual machine, so we suggest 8 GB just in case.
Warning: VT-x support is almost standard on any modern CPU, but it is usually disabled by the manufacturer in the computer BIOS settings. Please make sure you have VT-x enabled. Changing the Virtual machine to 32-bit will prevent it from starting.
2. Import the virtual machine
Tip: When extracting VHD file from .tgz archive, please use 7-zip file extractor.
Download the instructions on using the virtual machine with:
If your hypervisor is not listed, try importing the virtual machine anyway, following the instructions for using OVF (open virtualization format) appliances. Our virtual machine is generic.
3. Make sure you bind the network adapters properly
The virtual machine comes with multiple network adapters.
The first is bound to the NAT interface and is used for access to the outside world (internet). The other should be bridged to one of your internal networks. The internal network should assign an IP using DHCP, preferably with a static DHCP lease. This IP needs to be accessible on port 11113 by your JOAN devices.
You could also do port forwarding on NAT if you prefer – the only requirement is that the devices connect to the server on port 11113.
If a single network adapter can provide access to the internet and to the internal network, then the second one can be removed.
4. Start the virtual machine and log in
Start the virtual machine. You will be greeted with:
If the screen is black, please press "Enter" – the Virtual Machine might be displaying a screen saver.
You can log in using default user: joan, default password: joanaccess.
If you change the default settings, password or networking configuration, please make sure that the virtual machine has access to the internet (so it can reach the JOAN Portal for data about your calendars) and that JOAN devices have access to the server.
5. Connect your devices
Use the JOAN Configurator to reconfigure the devices. Enter your IP under the "Set the JOAN hosting" field. Save the settings.
6. System requirements
From 10 devices to 20 devices you need 2 CPUs
From 20 devices to 50 devices you need 4 CPUs
From 50 devices to 100 devices you need 6 CPUs
From 100 devices to 350 devices you need 10 CPUs
From 350 devices to 700 devices you need 16 CPUs
Example how to calculate the required resources for the VM:
30 devices * 220 MB RAM = 6,600 MB RAM (for the devices) + 2,000 MB (for stable VSS running).
So based on the example, you will need a total of 9 GB of RAM and 4 CPUs.
A little more explanation
JOAN devices are thin clients, meaning that they only show images retrieved from a server and process clicks, update firmware etc. by having a stable connection with a server, an on-premises server (through the Visionect Software Suite).
When choosing to host JOAN on premises, the Visionect Software Suite runs on your premises, on your server infrastructure.
The JOAN Portal, on the other hand, runs in the cloud. It connects your calendar to the JOAN devices and forwards events to your on-premises server so they can be displayed on JOAN's screen.
The JOAN Portal securely connects to your calendar through an encrypted connection. It fetches events for 1 week and forwards them to the on-premises server (using a secure https protocol). These events are then shown on JOAN's screen. No calendar events are permanently stored on our servers. They are only forwarded to the on-premises server and then to the devices.