forked from NangoHQ/nango
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/NangoHQ/nango
- Loading branch information
Showing
27 changed files
with
601 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
# | ||
############################################################################### |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,4 @@ node_modules/* | |
logs/* | ||
nango-data/* | ||
.idea/* | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,3 @@ | |
. "$(dirname -- "$0")/_/husky.sh" | ||
|
||
npm run prettier-format | ||
git add -A . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
18 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.