Hosting a typical FreightWise integration is usually straightforward. The following requirements are a basic starting point.
Note that these requirements may differ based upon the requirements of your specific integration - if so, the FreightWise IT / Dev. Team will discuss those changes with you.
We ship integrations in a Docker container. This allows us (FreightWise) to develop, test, and deploy in nearly identical environments, and it makes hosting on your (client) side as simple as possible. To host your integration, you'll need:
- A modern server OS capable of acting as a Docker host for linux containers (we recommend Ubuntu 20.04 LTS)
- Ubuntu 20+ (Long Term Support (LTS) recommended)
- Debian 9+
- CentOS 7+
- A Kubernetes Cluster
- An Amazon Web Services ECS Cluster
- Windows Server 2019 with Hyper-V (and an Ubuntu, Debian, or CentOS guest)
- Windows Server 2019 with Containers
- At least 1 GB of RAM dedicated to the container
- At least 30 GB of HD space dedicated to the container (on Windows, we recommend at least 120 GB dedicated to the FreightWise integration)
Egress (Outgoing traffic)
- Access to your production database or API
- Access to your staging database or API
- Access to your file server (for integrations with automatic PDF saving)
- Access to Amazon Web Services for receiving event information, sending log data, and downloading the container
- Access to
*.freightwise.appfor posting data back to the FreightWise application
- Access to the internet for security updates
Ingress (Incoming traffic)
- SSH access (optional - AWS SSM Agent can be used instead)
- All other incoming traffic should be blocked
When possible, we prefer to have direct SSH access to the server hosting the integration. If this is not possible, we have customers who provide us with VPN access or terminal server access where we can then SSH to the server. If this is not an option, you can install the AWS Systems Manager agent which will allow us to connect to the server. We will provide the agent activation code and id.
Deploying your Integration
We will build your integration and push it to the AWS Elastic Container Registry. We will then send you credentials and a script to pull down the container and run it on your server. On most linux servers, it will only take 1 command to install Docker and 1 command to install the FreightWise integration.