Documentation – Portharbor

Prelude

Nice to meet you! ou will find here some usefull information about configuration Portharbor.io pods, what kind of USB-RS232 adapter use. This page is stil in development. You can use thinclient even if you want to upgrade your Portharbor.io free account to Premium. TFTP service can run on USB-NIC.

Motto Let's make DB9 great again together!

Configuration

After you setup Portharbor.io minipc it’s time to start using it. Before this you need to setup serial connection parameters. You can do this in your account on Portharbor.io

Hardware

We have succesfully tested Portharbor.io installed on Raspberry Pi 4 ( 4 GB RAM, fast microSD card like: SanDisk EXTREME PRO microSD ). For professional ussage we reccomend to use server grade hardware. You can use thinclient even if you want to upgrade your Portharbor.io free account to Premium. TFTP service can run on USB-NIC.

USB Serial Adapters

Portharbor.io is tested with FTDI chip. If you buying new usb-serial adapter please be sure to buy oryginal one not a fake one. Fakes don’t have serial number so we can’t distinguish between them. Below you have example of supported usb-rs232 adapter based on oryginal FTDI chip.

# ls /dev/serial/by-id/*
/dev/serial/by-id/usb-FTDI_UC232R_FT4JTVQ7-if00-port0

As you can see in the name of device there is a serial number FT4JTVQ7. We support adapters with up to 32 serial ports to one USB. Like this one:

USB to 32-Port Serial Adapter

It is worth to know. You can mix different adapters together. Use Portharbor.io device with a single one or multi-serial adapters. Portharbor.io support hot plugging so you can add more adapters without downtime.

Installation

First verify your Docker & Docker Compose installation.

For Docker try this in your system:

$ docker -v
Docker version 24.0.6, build ed223bc

For Docker Compose try:

$ docker compose version
Docker Compose version v2.21.0

Installation process:

Portharbor.io should be installed in /opt/portharbor directory

$ mkdir /opt/portharbor
$ mkdir /opt/portharbor/tftp
$ chmod 777 /opt/portharbor/tftp

Enter to the /opt/portharbor folder and create file for Docker Compose: docker-compose.yaml using your favorite text editor.

$ cd /opt/portharbor
$ nano docker-compose.yaml

And paste content:

version: "3.8"

services:
  portharbor:
      image: portharbor/portharbor:latest
      environment:
          - MINI_PC_NAME=<name>
          - DC_IDENTIFICATOR=<dc-id>
          - API_KEY=<api-key>
          - DEVICE_UUID=<device-uuid>
          - TFTP_FILES_PATH=<tftp_files_path>
      volumes:
          - /run/udev:/run/udev:ro
          - /dev:/dev
          - /var/run/docker.sock:/var/run/docker.sock
          - <tftp_files_path>:/app/data/my_tftp_files
      privileged: true
      user: "root"
      network_mode: "host"
      restart: always
      group_add:
          - dialout
      command: sh -c "npm run start"

Next adjust variables:

MINI_PC_NAME – Put here name of your device ( without special characters )
DC_IDENTIFICATOR – For free version of Portharbor.io put cf57f6bc-56e3-11ee-8c99-0242ac120002, if you have Premium Version you should conntact to your Datacenter Administrator to get your DC_IDENTIFICATOR.
API_KEY – Put here your API KEY – you can find it in your profile on portharbor.io page.
DEVICE_UUID – Please enter random string ( you can use uuidgen to generate random UUID for your device )
TFTP_FILES_PATH – If you have Premium Version of Portharbor.io enter here path to folder for TFTP files. Remember to enter this path twice.

Save your changes and start Portharbor.io by command: docker compose up or this one for detached mode: docker-compose up -d

System requirements

Suported hardware:

AMD64 architecture
ARM64 architecture

Supported OS:

GNU/Linux

Hardware Requirements:

	Minimal	Recomended
`CPU`	1 GHz	Dual Core 2GHz
`RAM`	4 GiB	8 GiB
`Disk`	10 GiB	40 GiB
`Internet Access`	20 Mbps	100 Mbps

TFTP Function If you want use TFTP function it's recommended to get spare ethernet port with VLAN support.

Additional Requirements:

Docker (a version >= 20.10.2 is required)
Docker Compose (a version >= 2.0 is required)

Need help with Docker installation? You can check how to install Docker and Docker Compose in your distro on official Docker website.

HOSTTOP HOSTING

Pricing & Billing FAQs

Easily organise your infrastructure with Projects. And with Teams, everyone can get their own account, with just the privileges they need to do their jobs.