Philter Deployment Guide
The goal of this guide is to walk you through how to deploy Philter in your cloud. This guide is divided into individual steps to separate each step of the process. If you have any questions at any time please reach out to us and we will be glad to assist.
Cloud platforms can take different lengths of time for a new version of Philter to be made available. The table below tracks the Philter versions on each cloud platform.
|Cloud||Philter Version||Marketplace Link|
|Amazon Web Services||1.1.0||Launch Philter on AWS|
|Microsoft Azure||1.1.0||Launch Philter on Azure|
|Google Cloud Compute||1.0.1||Launch Philter on Google Cloud|
Philter Deployment Steps
As an introduction or a reminder, Philter accepts natural language (unstructured) text and identifies and removes PII and PHI from the text. This guide will show how to deploy Philter and get started filtering text.
Step 1 – Identify your platform
Philter is available on multiple public cloud platforms including Amazon Web Services, Microsoft Azure, and Google Cloud. Each of these cloud platforms has its own marketplace from which Philter is available.
The marketplaces conveniently allow self-service of your Philter subscription and allows the billing to be collected through your cloud account’s standard billing. The pricing and pricing models may vary between cloud providers due to fundamental differences between the platforms.
Step 2 – Launch Philter
The Philter deployment steps for each cloud platform are divided into tabs below. Select the tab for your chosen cloud platform and follow the provided instructions.
Amazon Web Services
Philter on AWS is a virtual machine-based product. It runs on EC2 on its own instance. A free trial period is available during which there is no charge for the Philter software but there may be charges for the underlying AWS infrastructure.
Launch Philter in AWS
- Go to the Philter listing in the AWS Marketplace. On this page you can see the Philter overview, the pricing, and the supported EC2 instance types.
- Select an instance type. We recommend m5.large. The smaller instance types are intended only for testing and not production usage.
- Click the “Continue to Subscribe” button.
- View and accept Philter’s license agreement. Then click “Accept Terms.”
- The subscription will now be created and you will be notified when it is ready! This usually only takes less than a minute.
- Click the “Continue to Configuration” button to select the AMI, the version, and the region. We recommend using the newest version if multiple are available.
- Click the “Continue to Launch” button to launch Philter in your AWS account!
Here’s a brief screen cast showing how to launch Philter in AWS.
Philter on Microsoft Azure is a virtual machine-based product. It runs on EC2 on its own instance. A free trial period is available during which there is no charge for the Philter software but there may be charges for the underlying AWS infrastructure.
- Go to the Philter listing on the Azure Marketplace.
- Click the “Get It Now” button.
- Review the information that is shown on the popup and click “Continue” when ready.
- You will now be asked to log in to your Microsoft Azure account if you were not already logged in.
- Click the “Create” button to begin making a Philter virtual machine.
- Enter the required details of the virtual machine and click the “Review + create” button.
- Review the virtual machine details and click “Create” when ready!
Your Philter virtual machine will now be launching. When it is finished continue on to Step 3 below and try it out!
Step 3 – Try it out!
With Philter now running in your cloud we can take it for a spin. We will send it some text to filter and look at the response we get back. The Philter virtual machine running in your cloud account should have a public IP address (unless you customized the deployment). We will use that public IP address to interact with Philter.
In the command below, replace
<PUBLIC_IP> with the virtual machine’s public IP address.
curl -k -X POST https://<PUBLIC_IP>:8080/api/filter --data "George Washington was a patient and his SSN is 123-45-6789." -H "Content-type: plain/text"
Now press enter to send the command. We are sending the text in the command to Philter for filtering. Philter will identify the patient (George Washington) and the SSN (123-45-6789) and redact those values in the response. You can always use curl to send text to Philter but there are also SDKs you can use, too.
Step 4 – Integration
Now that you have Philter running and know how to send text to it you are ready to integrate Philter into your existing workflow and systems. Philter’s API details how to send files to Philter.
Documentation and Assistance
The Philter User’s Guide is available to provide additional reference and we are available to assist. We look forward to hearing from you and hope you find Philter to be an integral part of your PII/PHI processing pipelines.