Installation

Installation#

Streamsheets is an open source project. Check out our GitHub. If you have a problem or question conact us over info@cedalo.com or have a look into our forum.

Streamsheets Community Edition#

We recommand to use the "Cedalo Platform" Installer, which installs Streamsheets, Mosquitto and the Management Center. In the installation process you are able to select which components will be installed.

Streamsheets Premium Edition#

The Streamsheets premium edition is an extension to the community edtion. It adds features for further complexity, better dashboarding and chart options and more streams. To find out more go to our homepage.

The installation details can vary from version to version and will be individually suited. Contact our team for your installation details: info@cedalo.com.

Custom Port Allocation#

What are ports?#

Ports handle communication over the internet, they make sure, that there are no conflicts in data transmission. All data transmitted over the internet is sent and received by using different kinds of protocols. Each protocol is assigned a specific port number. This way data streams can easily be managed and adjusted.

Which ports are allocated by Streamsheets?#

Streamsheets allocate a number of ports.

These are all used ports:

  • 1883 - MQTT Broker
  • 1884 - Internal MQTT Broker
  • 8080 - Gateway
  • 8081 - Reverseproxy
  • 8083 - Streams Service
  • 8088 - Gateway WebSocket API
  • 8090 - Gateway HTTP API
  • 9000 - WebUI
  • 40000-40100 - Streams Service (UDP)
  • 4840 - OPC UA
  • 6379 - Redis
  • 27017 - Internal MongoDB

How can I change ports?#

The port mapping is done via a .yml file in your Installer directory in the "docker-compose" folder. To change each port individually open the .yml file and search for the "ports" parameter of the service.

Port Mapping: The command and the .yml file always uses the structure port:port to adjust ports. This is because we map internal docker ports to the ports of the host system. The port on the left represents the port of the host system and the port on the right represents the internal docker port. The one that interests you, is the one of the host system.

Changing the port to 8082 would look like this:

8082:8081

When do I need to change ports?#

Sometimes other programs are blocking certain ports. Then you encounter error messages like this:

ERROR: for streamsheets-service-feeders Cannot start service streamsheets-service-feeders: driver failed programming external connectivity on endpoint streamsheets-service-feeders (3c98f65b49d5c5ad961c9fde5ef145f21bf385b5edc077e204a9b877834185be): Bind for 0.0.0.0:8083 failed: port is already allocated

Changing either the port of the Streamsheets or the port of the other program is then the only option, if you want to run both at the same time on this host system.

Streamsheets Mosquitto Broker Password#

Streamsheets comes with the MQTT Mosquitto Broker. The password will be randomly generated on installation and set once in the standard "MQTT Connector".

Find Password: Within the Streamsheets installation directory and find the "mosquitto" subfolder. Open the "pw_clear.txt" file to access your password.

Change Password: To change the broker password stop the installation via the "stop" script, delete the "pw.txt" & "pw_clear.txt" file and start again via the "start" script. The new password will be generated and again written into the "mosquitto" folder. Don´t forget to change the password in your MQTT connector!

System Requirements#

The minimum requirements for the Streamsheets are:

Backend:

  • Raspberry Pi 3 Model B (or comparable machine), see hardware specs.
  • Docker Compose 3.8
  • Docker 19.03

Frontend:

  • Browser: all modern browsers (Chrome, Firefox, Edge, Safari, Opera, Brave).
  • Not supported: IE
note

For Docker and Docker Compose we probably support previous versions as well, but we have not tested that yet. Same for browsers: we have not tested yet which are the minimal browser versions. Same for the hardware requirements: the Raspberry Pi 3 is just the least powerful computer that we have tested Streamsheets up to now.