---
title: OpenConnector overview
description: Run the open-source Connector runtime in your own environment and
  control credential storage, provider access, and action policy.
lang: en
canonical_url: https://oomol.com/en/docs/openconnector/
markdown_url: https://oomol.com/en/docs/openconnector.md
---

# OpenConnector overview

OOMOL OpenConnector is an open-source, self-hostable connection runtime. Use it when your organization needs to operate credential storage, provider connections, network access, action policy, logs, and upgrades inside its own environment.

The runtime exposes provider actions through MCP, HTTP, OpenAPI, and a web console. Agents and clients work with schemas, connection labels, scopes, and results while raw provider credentials remain inside your deployment boundary.

## Choose a deployment target

| Target | Use it when |
| --- | --- |
| Docker Compose | You want the shortest path to a local or single-server runtime |
| Source runtime | You are developing OpenConnector or provider executors |
| Cloudflare Workers | You want runtime records in D1 and temporary transit files in R2 |

The [self-hosting guide](/en/docs/openconnector-self-hosting/) covers all three targets.

## What you operate

Your team is responsible for:

- Admin and runtime access tokens.
- Credential encryption keys and sensitive runtime storage.
- The public origin used by OAuth callback URLs.
- Provider OAuth clients or API key configurations.
- Action allowlists and blocklists.
- Backups, network controls, monitoring, and upgrades.

## Connect providers

OpenConnector supports API key, custom credential, OAuth2, and no-auth provider connections. Start with the general [OAuth app configuration guide](/en/docs/openconnector-oauth-apps/), then open a provider-specific guide when the provider requires its own setup:

- [Google](/en/docs/openconnector-google-oauth-app/)
- [Microsoft](/en/docs/openconnector-microsoft-oauth-app/)
- [Slack](/en/docs/openconnector-slack-oauth-app/)
- [GitHub](/en/docs/openconnector-github-oauth-app/)
- [HubSpot](/en/docs/openconnector-hubspot-oauth-app/)
- [Notion](/en/docs/openconnector-notion-oauth-app/)

## Start with a protected runtime

Set an admin token and credential encryption key before exposing the runtime outside your own shell. Create separate runtime tokens for Agents and clients, and limit available actions to the operations they require.

Follow the [OOMOL OpenConnector self-hosting guide](/en/docs/openconnector-self-hosting/) to deploy the runtime. Then [call your self-hosted runtime with the OpenConnector SDK](/en/docs/openconnector-sdk/) from TypeScript.