Skip to content

Commit

Permalink
Improves to providers documentation (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
pushchris authored Oct 15, 2023
1 parent c6a37e6 commit 0aeb76b
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 19 deletions.
23 changes: 6 additions & 17 deletions docs/docs/how-to/settings/providers.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
# Providers
Providers are the backbone of the product and let you configure how your communications go out. Currently Parcelvoy supports four major types of communications:
- Email
- Text Message
- Push Notification
- Webhook
# Integrations
Integrations are the backbone of Parcelvoy and let you configure how your communications go out.

Between the four of those you should be able to handle just about anything.
Integrations are project specific meaning if you have a test and production project, you can have each one setup to use different providers.

Providers are project specific meaning if you have a test and production project, you can have each one setup to use different providers.

<Tip>See the (providers section)[/providers] for more information on each of the provider types we support!</Tip>

## Creating a Provider
To create a provider, nagivate to `Settings -> Providers` under the project you want to add one to. From there click `Add Provider`.

A modal will open which lets you pick from any of our currently supported providers. Selecting one will show you the required fields needed to setup that provider.

Consult any of our (provider pages)[/providers] for more information on getting them setup.
:::tip
See the [providers section](/providers) for more information on the integrations available.
:::

37 changes: 36 additions & 1 deletion docs/docs/providers/notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,40 @@
Currently Parcelvoy supports sending push notifications to the two largest push notification services (Apple & Google). Since push notifications are a single message type, both services are included inside of a single provider. If you do not wish to send notifications to one platform, just leave that section blank and any devices that fall into the excluded platform will be excluded from sends.

## APN (Apple Push Notifications)
### Enable In Xcode
To begin, you'll need to add the Push Notification capability to your app in Xcode. Please follow the steps on Apples ["Registering your app with APNs" article.](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns)

## Firebase (Google Push Notifications)
### Enable in Apple Developer Portal
1. Sign in to the [Apple Developer Portal](https://developer.apple.com/)
2. Select `Identifiers` under the `Certificates, IDs & Profiles` section.
3. Click on the identifier that corresponds to your app.
4. Under Capabilities, scroll down and check the Push Notifications capability.
5. Hit save in the top right corner.

### Create Token Authentication File
Parcelvoy only supports using a .p8 Token-basen authentication file to enable Apple Push Notification sending. This is the recommended approach by Apple, will let you send notifications to both production and development apps and does not expire.
1. Follow the instructions that Apple provides in their [Establishing a Token-Based Connection to APNs](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns) article.
2. Download the .p8 file you are provided.

### Setup Parcelvoy
1. Select the `APN & Firebase` integration or pick an existing integration.
2. Open the key you downloaded in a text editor and copy it into the `Key` field.
3. You can find the `Key ID` in the keys section of your Apple [developer account](https://developer.apple.com/account/). Make sure to use the key for the same p8 key you downloaded. Copy that in.
4. The `Team ID` is generated by Apple for your [developer account](https://developer.apple.com/account/). It can be found in the top right of your Apple developer account when you log in. Copy that in.
5. Your `Bundle ID` is the identifier for your app. You can find your Bundle ID in the Identifiers section of your Apple developer account or within Xcode Main `Target > General > Identity`. Copy this in as well.
6. Once these fields are filled, hit save.

## Firebase (Google Push Notifications)
### Setup Firebase
1. Follow Google's [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup) documentation to get Firebase integrated into your app.
### Create Service Account
1. Open Firebase, and click on the gear icon next to your project name.
2. Navigate to `Project Settings -> Cloud Messaging`
3. If Firebase Cloud Messaging API (V1) is disabled, then click the kebab menu icon on the top right corner and open the link. On the subsequent page hit Enable.
4. Now navigate to `Service Accounts` on the `Project Settings` page.
5. Click `Generate a new private key`. On the warning popup, hit `Generate key` and save the downloaded file.

### Setup Parcelvoy
1. Select the `APN & Firebase` integration or pick an existing integration.
2. Open the previously downloaded file in a text editor and copy the contents into the `Server Key` field.
3. Hit save.
10 changes: 10 additions & 0 deletions docs/docs/providers/posthog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# PostHog
Parcelvoy supports sending events to PostHog. Follow the instructions below to setup.

1. Open [PostHog](https://app.posthog.com) and navigate to `Project settings`
2. Scroll down to the `Project Variables` section and copy the `Project API Key` for later.
4. Navigate to the Parcelvoy integrations page, hit `Add Integration` and select the `PostHog` integration.
5. Enter the copied key into the `API Key` field.
6. If you are self hosting, please enter the host URL of your installation, otherwise you can leave that field blank or enter `https://app.posthog.com`
7. Check `Is Default` if you would like this to be where all analytic events are sent (this will override any other analytic integrations).
8. Save the integration and events will start sending immediately.
11 changes: 10 additions & 1 deletion docs/docs/providers/smtp.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
# SMTP
# SMTP
You can use the SMTP integration to send emails over pretty much any email account out there.

:::caution
While it is super easy to use any inbox to send with SMTP, please note that most inboxes have low daily send limits. It's recommended that you use a provider meant for sending emails.
:::

1. Navigate to the Parcelvoy integrations page, hit `Add Integration` and select the `SMTP` integration.
2. Fill in the `Host`, `Port` and authentication for your email account.
3. Hit `Create Integration`

0 comments on commit 0aeb76b

Please sign in to comment.