Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/NangoHQ/nango
Browse files Browse the repository at this point in the history
  • Loading branch information
rguldener committed Apr 20, 2023
2 parents 2003f2c + 146bedb commit a58f4a9
Show file tree
Hide file tree
Showing 27 changed files with 601 additions and 57 deletions.
54 changes: 54 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
###############################################################################
#
# Configuration
#
# - Secure requests to with an API. Used to secure endpoints related to provider configs and credentials.
#
# NANGO_SECRET_KEY=<PICK-A-SECRET-KEY>
#
# - To enable database credentials encryption, uncomment with a base64-encoded 256-bit key (warning: you cannot change this key once set).
#
# NANGO_ENCRYPTION_KEY=<ADD-BASE64-256BIT-KEY>
#
# - Customize database to store provider configurations and credentials.
# (running 'docker compose up' creates a local Postgres database with the following credentials)
#
# NANGO_DB_USER=<PICK-A-USERNAME>
# NANGO_DB_PASSWORD=<PICK-A-PASSWORD>
# NANGO_DB_HOST=<PICK-A-HOST>
# NANGO_DB_PORT=<PICK-A-PORT>
# NANGO_DB_NAME=<PICK-A-DB-NAME>
# NANGO_DB_SSL=<PICK-TRUE-OR-FALSE>
#
#
# - Configure server port (current value is the default for running Nango locally).
#
SERVER_PORT=3003
#
#
# - Configure server full URL (current value is the default for running Nango locally).
#
NANGO_SERVER_URL=http://localhost:3003
#
#
# - Configure a custom callback URL (by default it is NANGO_SERVER_URL/oauth/callback).
#
# NANGO_CALLBACK_URL=<CUSTOM-CALLBACK-URL>
#
#
# - Configure the username and password for securing Nango's dashboard.
#
# NANGO_DASHBOARD_USERNAME=<PICK-A-USERNAME>
# NANGO_DASHBOARD_PASSWORD=<PICK-A-PASSWORD>
#
#
# - Set the log level (debug: most verbose, info: recommended for production, error: least verbose)
#
LOG_LEVEL=info
#
#
# - Telemetry is minimal, anonymous and helps us improve (set to false to disable).
#
# TELEMETRY=false
#
###############################################################################
17 changes: 17 additions & 0 deletions .github/workflows/validation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Yaml Validation

on: [push]

concurrency:
group: validation-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
validation:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Lint yaml files
uses: ibiqlik/action-yamllint@v3
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ node_modules/*
logs/*
nango-data/*
.idea/*
.env
1 change: 0 additions & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@
. "$(dirname -- "$0")/_/husky.sh"

npm run prettier-format
git add -A .
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18
9 changes: 9 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: default

rules:
line-length:
max: 200
level: warning
document-start: disable
truthy:
check-keys: false
43 changes: 43 additions & 0 deletions docs/docs/providers/bamboohr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_label: BambooHR
---

# BambooHR API wiki

:::note Working with the BambooHR API?
Please add your learnings, favorite links and gotchas here by [editing this page](https://github.com/nangohq/nango/tree/master/docs/docs/providers/bamboohr.md).

:::

## Using BambooHR with Nango

Provider template name in Nango: `bamboohr`
Follow our [quickstart](../quickstart.md) to add an OAuth integration with BambooHR in 5 minutes.

## Creating integration and connection

For creating an integration with BambooHR instance, one would need the following details:

1. client_id
2. client_secret
3. scopes (use the default value: `openid,email`)

Please check the page https://documentation.bamboohr.com/docs/getting-started#what-will-you-need-to-get-started for details on how to get the `client_id` and `client_secret`

BambooHR uses account specific authorization url and token url, hence Nango uses parametrized urls in the provider config for BambooHR. You need to pass the `subdomain` of your account as a parameter to the Connection config.

For e.g: if the subdomain for your account is `foo`, then you need to pass the following connection config:

```json
{
"subdomain": "foo"
}
```

## Useful links

- [Web API docs (their REST API)](https://documentation.bamboohr.com/docs/getting-started)

- [How to register/integrate an Application](https://documentation.bamboohr.com/docs#what-will-you-need-to-get-started)

- [OAuth-related docs](https://documentation.bamboohr.com/page/single-sign-on-sso-with-openid-connect)
10 changes: 5 additions & 5 deletions docs/docs/providers/zoho-desk.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
sidebar_label: Zoho-desk
sidebar_label: Zoho Desk
---

# Zoho-desk API wiki
# Zoho desk API wiki

:::note Working with the Asana API?
:::note Working with the Zoho Desk API?
Please add your learnings, favorite links and gotchas here by [editing this page](https://github.com/nangohq/nango/tree/master/docs/docs/providers/zoho-desk.md).

:::

## Using Asana with Nango
## Using Zoho Desk with Nango

Provider template name in Nango: `zoho-desk`
Follow our [quickstart](../quickstart.md) to add an OAuth integration with Asana in 5 minutes.
Follow our [quickstart](../quickstart.md) to add an OAuth integration with Zoho Desk in 5 minutes.

## App registration & publishing

Expand Down
4 changes: 3 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,10 @@ const sidebars = {
'providers/amazon',
'providers/asana',
'providers/atlassian',
'providers/bamboohr',
'providers/battlenet',
'providers/bitbucket',
'providers/boldsign',
'providers/box',
'providers/braintree',
'providers/brex',
Expand All @@ -174,7 +176,7 @@ const sidebars = {
'providers/digitalocean',
'providers/discord',
'providers/dropbox',
'providers/dropbox',
'providers/docusign',
'providers/epic-games',
'providers/facebook',
'providers/factorial',
Expand Down
Loading

0 comments on commit a58f4a9

Please sign in to comment.