This article is written for those who were searching for a detailed and simple for the understanding guide on how to install Joan device control panel on Ubuntu Server.
In this guide, we will consider the case when you already have a server with the Ubuntu Server 18.04 LTS operating system installed on it.
You can read more about how to install Ubuntu Server 18.04 LTS in my guide «Installing Ubuntu Server 18.04 LTS».
Also on the server must be installed Docker Engine – Community and Docker Compose.
You can learn how to install Docker Engine – Community on Ubuntu Server by reading «Installing Docker Engine – Community on Ubuntu Server».
In my guide «Installing Docker Compose on Ubuntu Server», you can learn how to install Docker Compose on Ubuntu Server.
Please note that for proper operation of Joan devices you will need to open the following TCP ports for public access to your server:
- 8089 – to access new firmware for Joan devices.
- 443 – to access https://portal.getjoan.com.
You will also need to open the following TCP ports for web access to the server control panel and for access of Joan devices to your server:
- 8081 – for web access to the Joan device control panel.
- 11113 – to access Joan devices to the management server.
In addition, OpenSSH must be installed on the server, and port 22 must be open in order to be able to connect to the server using the SSH protocol.
To install OpenSSH on the server, you can use the command:
sudo apt-get install openssh-server
If you plan to connect to the server using the Windows operating system, you can use PuTTY, a freeware client for various remote access protocols, including SSH, Telnet, rlogin.
This guide covers connecting to a server using the iTerm2 terminal emulator installed on the macOS operating system.
Connect to the server on which it is planned to install the Joan device control panel.
Create a new directory that will be needed for the “docker-compose.yml” file using the command:
sudo mkdir /opt/visionect
Now download the “docker-compose.yml” file, which already contains the instructions needed to start and configure services for managing Joan devices using the command:
sudo wget /opt/visionect/ https://docs.visionect.com/_downloads/docker-compose.yml
If docker-compose.yml is not available for download, then you can create it yourself using the command:
sudo vim /opt/visionect/docker-compose.yml
The contents of the file should be as follows:
version: "3" services: vss: container_name: vss image: visionect/visionect-server-v3 privileged: true cap_add: - MKNOD - SYS_ADMIN devices: - "/dev/fuse:/dev/fuse" restart: unless-stopped links: - "postgres_db:postgres" - "redis:redis" ports: - 8081:8081 # admin browser - 11113:11113 - 32991:32991 # GW RPC - 11114:11114 #STORAGE - 11115:11115 #NM - 32989:32989 #NM RPC - 5559:5559 # broker 1 - 5560:5560 # broker 2 environment: - DB2_1_PORT_5432_TCP_ADDR=postgres - DB2_1_PORT_5432_TCP_USER=visionect - DB2_1_PORT_5432_TCP_PASS=visionect - DB2_1_PORT_5432_TCP_DB=koala - REDIS_ADDRESS=redis:6379 volumes: - /dev/shm:/dev/shm postgres_db: container_name: pdb image: postgres:9.6 restart: always ports: - 5432:5432 environment: - POSTGRES_USER=visionect - POSTGRES_DB=koala - POSTGRES_PASSWORD=visionect volumes: - /var/pgdata:/var/lib/postgresql/data redis: ports: - "6379:6379" image: redis:5.0.5 restart: always
Now create and run the containers necessary for the Joan device control panel to work using the command:
sudo docker-compose up -d
The containers will be created and launched following the instructions provided in the docker-compose.yml file.
Verify that the containers for managing Joan devices were successfully created and launched using the command:
sudo docker ps -a
Containers have been successfully created and launched.
To access the Joan device control panel, you must go from workstation to the link http://18.104.22.168:8081, where 22.214.171.124 is the name of my server. Accordingly, you need to specify the name or IP address of your server with the Joan device control panel installed.
In the next step, you will be asked to set a new password for the admin account, which is used to access the Joan device control panel.
Welcome to the Joan device control panel.