Installing the Bryx Dispatch Courier (Linux)

Modified on Mon, 1 Jul at 2:19 PM


The Bryx Dispatch Courier is a lightweight piece of software designed to monitor live CAD output. Courier monitors a directory for file creation events or a SQL database for newly created data. Information from these files is then sent to Bryx for processing with secure HTTPS authentication. Courier allows you to register for uptime emails to ensure reliable service. 


To install the Bryx Dispatch Courier software, please visit https://downloads.bryx.com/


For the Linux version of the software, the link will be under Core Files for Linux-AMD64.



Once the file is downloaded to the linux server, it will need to be marked as executable:

sudo chmod +x dispatch-courier

Take note of the location that the dispatch-courier software has been saved to as it will be needed in the following steps.


For systems running the systemd service system, a systemd service for courier can be created by making a dispatch-courier.service file in the /etc/systemd/system/ directory.


The contents of the file should be:


[Unit]
Description=Dispatch Courier

[Service]
Type=simple
ExecStart=/usr/local/bin/dispatch-courier
Restart=on-failure
WorkingDirectory=/etc/courier/
User=root

[Install]
WantedBy=multi-user.target

Notes:

ExecStart should be updated to wherever the dispatch-courier software was saved to.

WorkingDirectory should be set to where the dispatch-courier configuration will be saved.

User=root will avoid potential user access issues, but can be set to a different user.  Bryx will be unable to troubleshoot any issues arising due to user permission errors.


A config.json file should be placed in whatever directory was set as the WorkingDirectory for the dispatch-courier software.


The content of the json file should be as follows:


{
  "mode": "file",
  "workers": 10,
  "dedupe": false,
  "logFile": "/var/log/dispatch-courier/courier.log",
  "cloud": {
    "providerToken": "providerToken",
    "destinationId": "destinationID",
    "server": "bryx911.com",
    "endpoint": "dispatch",
    "ignoreSSLErrors": false,
    "httpProxyUrl": null
  },
  "files": {
     "path": "/home/user/upload",
     "processingPath": "processing",
     "processingCopy": false,
     "keep": false,
     "noScan": false
  },
  "database": null,
  "avl": null
}

The providerToken and destinationId should be updated to the ones provided by Bryx.


The logFile can be updated to any desired location.

The path directory should be updated to where the CAD output data is being written.


Note: The courier software will need to have permission for all these directories.


Once both the configuration and the systemd service are created, the service can be enabled with the following command:


sudo systemctl enable dispatch-courier.service

Then the service can be started with:


sudo systemctl start dispatch-courier.service


Once the software is running a test file can be saved into the path directory set in the config.json  The contents of the test file aren't important, but the file should not be empty.


Confirm with Bryx support that the test file was received.  From there once CAD data is fed into the directory it will automatically be sent to Bryx for processing.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article