Check its license. It has its own license: read it before using it for work.

Is nango still maintained?

Yes, active. Last change today. Latest release v0.72.4, 3 days ago.

Widely used. 13k stars, 6 years old, by an organization. As with any download, get it from the official repo.

gitmanual

Reading the repo

Opening the box…

How to install nango on Linux (NangoHQ/nango) · gitmanual

How to install on Linux

NangoHQ/nango

Connect your agents & product to 1,000 APIs.

Node.js#access-token#api#api-client#api-integration

Before you start

Is it free?: Check its licenseIt has its own license: read it before using it for work.
Still maintained?: Yes, activeLast change today. Latest release v0.72.4, 3 days ago.
Can I trust it?: Widely used13k stars, 6 years old, by an organization. As with any download, get it from the official repo.

Difficulty: Involved
Time: 30 min or more
Stars: ★ 13,207
Activity: Updated this month

Fresh setup, read just now

Will it work on Linux?

Yes, it runs on Linux

You'll build it yourself with Node.js.
It also needs PostgreSQL, Redis running (Docker handles this).

Your system

macOS Windows Linux

Start here

Website ↗nango.devThe project's own site.

Also: Docs ↗

Heads-upBuilding it yourself? It also needs PostgreSQL, Redis and 26 settings in .env (4 secret).

From the maintainers

Development setup: `DEVELOPMENT.md`

Development setup

Develop locally

Clone the repository and install dependencies:

git clone https://github.com/NangoHQ/nango.git
cd nango
npm ci
npm run prepare

Create your environment file:

cp .env.example .env

Start the databases and queue:

npm run dev:docker

Run Nango in two separate terminals:

npm run dev:watch

npm run dev:watch:apps

Open http://localhost:3000.

Run integrations

Create a directory for your integrations and install the CLI:

mkdir nango-integrations
cd nango-integrations
npm install --global nango
nango init

Set NANGO_SECRET_KEY_DEV and NANGO_HOSTPORT in .env, then deploy:

nango deploy dev

See the CLI documentation for more information.

Open DEVELOPMENT.md on GitHub ↗

6 steps on Linux

Download setup.sh

Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

Clone the repository

git clone https://github.com/NangoHQ/nango.git
cd nango

Install the required runtimes

Node.js 22.23.4

# needs nvm: https://github.com/nvm-sh/nvm
nvm install
nvm use

3
Configure environment variables
Fill in secrets: NANGO_METRICS_INCLUDE_PROVIDER_CONFIG_KEY, WORKOS_API_KEY, GOOGLE_APPLICATION_CREDENTIALS, PUBLIC_LOGODEV_KEY
```
cp .env.example .env
```
4
Start backing services
Needs: PostgreSQL, Redis
```
# needs Docker Engine: https://docs.docker.com/engine/install/
docker compose -f docker-compose.yaml up -d
```
If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
5
Install dependencies
```
npm ci
```
6
Run the tests
```
npm test
```

From the README: Quickstart

Get up and running in under 5 minutes:

1. Create an integration. Sign up (free, no credit card), then configure a new integration in the Integrations tab.

2. Authorize the API. On the Connections tab, create a connection and complete the auth flow. Later, embed this in your product:

nango.openConnectUI({ onEvent: (event) => { /* handle completion */ } });

3. Access the API. Retrieve credentials and make authenticated requests:

import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const connection = await nango.getConnection('<INTEGRATION-ID>', '<CONNECTION-ID>');
console.log(connection.credentials);

Embed the Auth flow in your product, make requests with the Proxy, or build custom integrations with Functions.

Did you get it running?

No reports for Linux yet.

Still stuck? Get a written guide

GitManual AI Agent reads the 13 key files and writes a step-by-step guide for Linux. Once written, it's saved for everyone.

Parts list

1×Node.js 22.23.4runtime
1×npm package manager
1×PostgreSQL service
1×Redis service

26× settings in .env

SERVER_PORToptional
WORKER_PORToptional
NANGO_SERVER_URLoptional
NANGO_PROXY_BASE_URL_OVERRIDE_ENABLEDoptional
NANGO_PROXY_BASE_URL_OVERRIDE_DENYLISToptional
NANGO_PUBLIC_SERVER_URLoptional
CSP_REPORT_ONLYoptional
LOG_LEVELoptional
TZ
NANGO_INTEGRATIONS_FULL_PATH
NANGO_TELEMETRY_SDK
NANGO_METRICS_INCLUDE_PROVIDER_CONFIG_KEYsecret
NANGO_LOGS_ENABLED
NANGO_LOGS_PROVIDER
NANGO_LOGS_ES_URL
NANGO_LOGS_ES_USER
NANGO_LOGS_ES_PWD
NANGO_LOGS_ES_RETENTION_DAYS
WORKOS_API_KEYsecret
WORKOS_CLIENT_ID
GOOGLE_APPLICATION_CREDENTIALSsecret
ORCHESTRATOR_SERVICE_URL
PUBLIC_LOGODEV_KEYsecret
NANGO_PUBLIC_CONNECT_URL
NANGO_CONNECT_UI_PORT
FLAG_SERVE_CONNECT_UI

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/NangoHQ/nango/badge.svg)](https://gitmanual.com/NangoHQ/nango)

Good to know

Monorepo (workspaces) — install from the repo root.
Dockerfile available (base image: badouralix/curl-jq).
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: packages/audit/package.json, packages/authz/package.json, packages/billing/package.json, packages/cli/example/package.json and 11 more

Details

License: Not detected
Open issues: 126
Branch: master

package.json scripts (54)

create:migrationcd packages/database/lib && knex migrate:make $1 --esm --knexfile ./knexfile.cjs
undo:migrationcd packages/database/lib && knex migrate:rollback --esm --knexfile ./knexfile.cjs
formatprettier --config .prettierrc "./**/*.{ts,tsx}" --write
format:checkprettier --config .prettierrc "./**/*.{ts,tsx}" --check
format:watchonchange './**/*.{ts,tsx}' -- prettier --write {{changed}}
lintoxlint -c .oxlintrc.json
lint:fixoxlint -c .oxlintrc.json --fix
ts-buildtsc -b tsconfig.build.json
ts-build:dockertsc -b tsconfig.docker.json
ts-cleannpx rimraf packages/*/tsconfig.tsbuildinfo packages/*/dist
webapp-buildcd ./packages/webapp && npm run build && cd ../..
webapp-build:watchtsc -b -w packages/webapp/tsconfig.json
docker-build:unified./scripts/build_docker.sh
build:hostednpm ci && npm run ts-build && npm run webapp-build && npm run connect-ui:build
build:prodnpm ci && npm run ts-build && npm run webapp-build
server:dev:watchcd ./packages/server && npm run dev
jobs:dev:watchnpm run dev -w @nangohq/nango-jobs
persist:dev:watchnpm run dev -w @nangohq/nango-persist
orchestrator:dev:watchnpm run dev -w @nangohq/nango-orchestrator
metering:dev:watchnpm run dev -w @nangohq/nango-metering
seed:clickhouseLOG_LEVEL=warn tsx -r dotenv/config scripts/seed-clickhouse.ts dotenv_config_path=.env
webapp:dev:watchcd ./packages/webapp && npm run dev
connect-ui:dev:watchcd ./packages/connect-ui && npm run dev
connect-ui:buildnpm run -w @nangohq/connect-ui build
preparehusky install

Files we read (13)

.env.example

.github/workflows/build-image.yaml

.github/workflows/lint-pr.yaml

.github/workflows/lint.yaml

.github/workflows/tests-clients.yaml

.github/workflows/tests.yaml

.github/workflows/tokens-check.yaml

.nvmrc

DEVELOPMENT.md

Dockerfile

README.md

docker-compose.yaml

package.json

12,035 files in the repo

Yes, it runs on Linux

Start here

Development setup: DEVELOPMENT.md

Development setup

Develop locally

Run integrations

6 steps on Linux

Clone the repository

Install the required runtimes

Configure environment variables

Start backing services

Install dependencies

Run the tests

From the README: Quickstart

Did you get it running?

Still stuck? Get a written guide

More like nango that run on Linux

Development setup: `DEVELOPMENT.md`