3.1 Install (Linux)

This section describes how to install/uninstall SpeeDBee Synapse (Linux).

3.1.1 Execution environment#

The system requirements for this package are Ubuntu20 (AMD64)/Ubuntu22(AMD64, ARM64).
For environments other than those listed above, please refer to the manual for the relevant environment.

In the case of using Data Flow Controller, Synapse is pre-installed. so you do not need to follow the instructions in this chapter.

3.1.2 Installation and Updates#

Follow the instructions below to install SpeeDBee Synapse on your device. The same procedure is used when updating.

Place File

Place the file SpeeDBee Synapse in the /tmp directory on the device. The following is an example of deployment using the scp command from Windows PowerShell.
If the device OS is Ubuntu20 (amd64)If the device OS is Ubuntu22 (amd64)If the device OS is Ubuntu22 (arm64)If the device OS is Raspberry Pi OS (bookworm 64 bit)If the device OS is debian12 (bookworm arm64)
PS >scp speedbeesynapse_ubuntu20_x.x.x-r0_amd64.deb (account name)@(device IP address):/tmp
Note: Where x.x.x is the version number.
PS >scp speedbeesynapse_ubuntu22_x.x.x-r0_amd64.deb (account name)@(device IP address):/tmp
Note: Where x.x.x is the version number.
PS >scp speedbeesynapse_ubuntu22_x.x.x-r0_arm64.deb (account name)@(device IP address):/tmp
Note: Where x.x.x is the version number.
PS >scp speedbeesynapse_raspi_bookworm_x.x.x-r0_arm64.deb (account name)@(device IP address):/tmp
Note: Where x.x.x is the version number.
PS >scp speedbeesynapse_debian12_x.x.x-r0_arm64.deb (account name)@(device IP address):/tmp
Note: Where x.x.x is the version number.

Installation and Startup

Log in to the device using ssh. The following is an example of using the ssh command to log in from Windows PowerShell.
```
PS >ssh (account name)@(device IP address)
```
Run the following command to install SpeeDBee Synapse:
If the device OS is Ubuntu20 (amd64)If the device OS is Ubuntu22 (amd64)If the device OS is Ubuntu22 (arm64)If the device OS is Raspberry Pi OS (bookworm 64 bit)If the device OS is debian12 (bookworm arm64)
$ sudo apt install /tmp/speedbeesynapse_ubuntu20_x.x.x-r0_amd64.deb
Note: Where x.x.x is the version number.
$ sudo apt install /tmp/speedbeesynapse_ubuntu22_x.x.x-r0_amd64.deb
Note: Where x.x.x is the version number.
$ sudo apt install /tmp/speedbeesynapse_ubuntu22_x.x.x-r0_arm64.deb
Note: Where x.x.x is the version number.
$ sudo apt install /tmp/speedbeesynapse_raspi_bookworm_x.x.x-r0_arm64.deb
Note: Where x.x.x is the version number.
$ sudo apt install /tmp/speedbeesynapse_debian12_x.x.x-r0_arm64.deb
Note: Where x.x.x is the version number.
Installation routed through a proxy

In environments where a proxy server (forward proxy) is deployed within the organization, proxy connection information must be explicitly configured to perform the installation. Please specify the environment variables http_proxy and https_proxy as shown in the command below.
```
$ sudo http_proxy=<url of proxy server> https_proxy=<url of proxy server> apt install ...
```
Note: To specify a username and password for Basic Authentication, include them in the URL as follows.
```
http://<username>:<password>@<host>:<port>
```
Run the following command to start SpeeDBee Synapse:
```
$ sudo systemctl start speedbeesynapse
```

Access from browser

You can open the SpeeDBee Synapse window by accessing the following URL from your browser.
- http://{hostname or device IP address}:8120
  
  Example)http://192.168.1.3:8120
  
  About PCs accessing SpeeDBee Synapse
  
  From a PC belonging to the same network as the installed device, use a browser (Google Chrome/Microsoft Edge) to access the URL of SpeeDBee Synapse.
  To access by host name, you need to set up an environment that allows the PC to access by host name.
  Note: The operation has been confirmed with some iPad terminals (using Safari), and basic operations are possible.
  
  After the Update
  
  If SpeeDBee Synapse is updated while the screen is open and operations are continued without reloading, the system may not function correctly. Please reload the screen before performing any operations after the update. If you experience issues such as newly added screen items not appearing after the update, please clear your browser’s cache.
Because it is through http, a security warning may appear on the screen when you access it for the first time.

Access via https

You can also access SpeeDBee Synapse via https. For details, see "HTTP/HTTPS Communication".

3.1.3 Control operate for SpeeDBee Synapse#

You can control SpeeDBee Synapse by logging in using ssh to the device where SpeeDBee Synapse is installed and running the following commands:

Start
```
$ sudo systemctl start speedbeesynapse
```

Restart

$ sudo systemctl restart speedbeesynapse

Stop
```
$ sudo systemctl stop speedbeesynapse
```
Enabling Autostart

This setting enables SpeeDBee Synapse to start automatically when the device is restarted.
```
$ sudo systemctl enable speedbeesynapse
```
Disabling Autostart

When this setting is applied, the SpeeDBee Synapse service does not start when the device is restarted.
```
$ sudo systemctl disable speedbeesynapse
```

3.1.4 Uninstall#

You can uninstall SpeeDBee Synapse from the device by following the instructions below.

Log in to the device using ssh. The following is an example of using the ssh command to log in from Windows PowerShell.
```
PS >ssh (account name)@(device IP address)
```
Run the following command to uninstall SpeeDBee Synapse:
- Keeping logs and configuration files
```
$ sudo apt remove speedbeesynapse
```
- To delete all logs and configuration files
```
$ sudo apt purge speedbeesynapse
```

To reinstall SpeeDBee Synapse, follow the procedure described in the Installation section.

If logs and configuration files were left during uninstallation, the settings will be retained after reinstallation.