Skip to content
This repository has been archived by the owner on Dec 31, 2022. It is now read-only.

Commit

Permalink
Merge pull request #99 from Fairbanks-io/develop
Browse files Browse the repository at this point in the history
Shields
  • Loading branch information
jonfairbanks authored Aug 14, 2021
2 parents 4fdfb11 + 30aab0c commit e2611d3
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 10 deletions.
3 changes: 2 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ logo.*
*.jpg
*.bmpr
*.sample
.env*
.env*
.prettier*
13 changes: 13 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
__tests__/*
.github/*
chart/*
.*ignore
.*rc
*.md
package.json
package-lock.json
build
*.yaml
*.yml
*.config.js
.env*
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": false,
"singleQuote": true
}
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

A Node.js and MongoDB based listener for PayPal IPN events.

![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/fairbanksio/paypal-ipn-listener.svg)
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/fairbanksio/paypal-ipn-listener.svg)
![GitHub Workflow Status](<https://img.shields.io/github/workflow/status/Fairbanks-io/PayPal-IPN-Listener/Create%20Release(s)?label=Docker%20Build>)
![GitHub top language](https://img.shields.io/github/languages/top/Fairbanks-io/PayPal-IPN-Listener.svg)
![Docker Pulls](https://img.shields.io/docker/pulls/fairbanksio/paypal-ipn-listener.svg)
![GitHub](https://img.shields.io/github/license/Fairbanks-io/PayPal-IPN-Listener.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/Fairbanks-io/PayPal-IPN-Listener.svg)
![Lines of code](https://img.shields.io/tokei/lines/github/jonfairbanks/docker-node-init)
![License](https://img.shields.io/github/license/Fairbanks-io/PayPal-IPN-Listener.svg)

## Getting Started

Expand Down Expand Up @@ -46,24 +46,26 @@ The IPN listener should now be running on http://localhost:8888
This IPN Listener is also available on [Dockerhub](https://hub.docker.com/r/fairbanksio/paypal-ipn-listener).

To launch the Dockerfile, the following can be used as an example:

```sh
docker run -d -p 8888:8888 -e 'MONGO_URI=mongodb://user:password@localhost:27018/paypal' --restart unless-stopped --name 'paypal-ipn' fairbanksio/paypal-ipn-listener
```

The IPN listener should now be running on http://localhost:8888

If you need to get into the container for some reason, simply run the following on the Docker host:

```sh
docker exec -it paypal-ipn /bin/bash
```

## Environment Variables

| ENV | Required? | Details | Example |
|----------------|-----------|------------------------------------------------------------------------------------------------|--------------------------------------------------|
| `MONGO_URI` | No | What Mongo instance to use. If the ENV is not provided, `mongodb://localhost/paypal` is used. | `mongodb://user:password@localhost:27018/paypal` |
| `LOG_LOCATION` | No | Override where the IPN log is written. By default the log is written into the app directory. | `/Logs/ipn.log` |
| `PORT` | No | Override the application port. Defaults to 8888. | `8889` |
| ENV | Required? | Details | Example |
| -------------- | --------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| `MONGO_URI` | No | What Mongo instance to use. If the ENV is not provided, `mongodb://localhost/paypal` is used. | `mongodb://user:password@localhost:27018/paypal` |
| `LOG_LOCATION` | No | Override where the IPN log is written. By default the log is written into the app directory. | `/Logs/ipn.log` |
| `PORT` | No | Override the application port. Defaults to 8888. | `8889` |

## Configure Nginx

Expand Down Expand Up @@ -95,4 +97,4 @@ server {
}
```

The IPN listener should now be available on the URL configured when setting up Nginx. To complete setup, [update your IPN url](https://developer.paypal.com/docs/classic/ipn/integration-guide/IPNSetup/) on PayPal and run a test payment with the [IPN Simulator](https://developer.paypal.com/developer/ipnSimulator/).
The IPN listener should now be available on the URL configured when setting up Nginx. To complete setup, [update your IPN url](https://developer.paypal.com/docs/classic/ipn/integration-guide/IPNSetup/) on PayPal and run a test payment with the [IPN Simulator](https://developer.paypal.com/developer/ipnSimulator/).

0 comments on commit e2611d3

Please sign in to comment.