# Frequently Asked Questions

## What is SelfDocHub?

SelfDocHub is a self-hosted hub for collecting, merging, and publishing API documentation. Your
services push their OpenAPI/Swagger, GraphQL, OpenRPC or AsyncAPI specifications to a SelfDocHub
instance running on your own infrastructure; SelfDocHub merges every submission into a single
searchable, versioned web UI. This site is the licensing portal — it's where you buy a subscription
and issue the license files that unlock your SelfDocHub installation. The full product guide is in
the [documentation](/documentation/introduction).

## Which specification formats are supported?

- **OpenAPI / Swagger** (REST). Swagger 2.0 is converted to OpenAPI 3.
- **GraphQL** schemas, as SDL text or an introspection result.
- **OpenRPC** (JSON-RPC).
- **AsyncAPI** 2.0–2.6 and 3.x, for event-driven APIs.

A service uses exactly one format, detected from its first published version.

The interactive **Try-It** panel runs live requests straight from the docs for REST, GraphQL and
JSON-RPC services. AsyncAPI services have no Try-It. You can also layer **Markdown overlays** on top of
endpoints, tags, services and even single parameters to add hand-written notes without touching the
source spec.

## What can I do with the documentation once it is published?

- Browse and search every service in one place, with your own **folders, tags and text pages** arranged
  in the left menu.
- Follow **version history**, branches and a **Change Log** that flags breaking changes.
- Send and save requests with **Try-It**, share them by link and copy them as code (curl, Go, Python,
  JavaScript, PHP, C#).
- **Export** selected parts to DOCX, PDF, HTML or Markdown, with your own cover pages.
- Let AI tools read the documentation through the built-in **MCP server**.
- Get **notifications** about new versions and license expiry by webhook, email, Telegram or Slack.

See [Using the Hub](/documentation/services-and-groups) for details.

## Does SelfDocHub require a separate database server?

No. SelfDocHub stores users, teams, settings, and version/history metadata in an embedded SQLite
database file that lives inside the instance's own data directory — there's no separate database
server to install, patch, or scale. The underlying API documents (specs, merged snapshots, overlays,
exports) are stored alongside it as plain files. Back up that one data directory and you've backed up
everything. See [Upgrading and Backups](/documentation/upgrading-and-backups).

## How do I install it?

SelfDocHub is a single binary with the web interface embedded. You can run it on a Linux server behind
Nginx or in Docker. See [Installation](/documentation/installation) for both options and
[Quick Start](/documentation/quick-start) for a local trial.

## How do I get my services' documentation into SelfDocHub?

1. Deploy your own SelfDocHub instance and register a service. An administrator does this in the web
   interface or on the command line, and receives the service's upload token once.
2. Have each service push its specification to the instance over the HTTP ingest API from its CI
   pipeline.
3. SelfDocHub stores the version, merges it into the service's documentation and publishes it in the
   web UI.

Administrators and editors can also import a specification file by hand from the service page. See
[Publishing a Specification](/documentation/publishing-specifications).

## Who can do what in SelfDocHub?

There are three roles. **Readers** browse, search, use Try-It and export. **Editors** also edit overlays,
text pages, labels and the service structure, and import or delete versions. **Administrators** manage
users, teams, services, integrations and the license. Readers and editors only see the services of their
teams. See [Roles and Permissions](/documentation/roles-and-permissions).

## Does it support single sign-on and two-factor authentication?

Yes. Administrators can switch on two-factor authentication (TOTP) per user. Single sign-on works with
OpenID Connect providers such as Keycloak, Microsoft Entra ID, Okta and Google Workspace, with optional
automatic user creation and group-to-role and team mapping. SSO is a licensed feature, so check that your
license includes it. See [Single Sign-On (SSO)](/documentation/single-sign-on).

## Can AI assistants use my documentation?

Yes. SelfDocHub has a built-in MCP (Model Context Protocol) server. Administrators create access tokens,
each limited to chosen services, and connect them to MCP-capable clients. By default access is read-only.
An optional, separately licensed Try-It mode lets a model send real requests to environments you open to
it. See [MCP Server](/documentation/mcp-server) and [Try-It Through MCP](/documentation/mcp-try-it).

## How does licensing work?

SelfDocHub requires a signed license file to unlock its API and documentation UI beyond the login
and license pages. A license is tied to a single installation's `device_id` — a random identifier
generated once by that installation and stable for its lifetime. To get a license:

1. Subscribe to a plan here — each plan includes a fixed number of installation licenses you can
   issue.
2. Get your installation's `device_id` (shown on its License page, or via its command-line tool).
3. From your dashboard here, enter the `device_id` and generate the license file.
4. Upload the resulting `license.json` to your SelfDocHub instance's License page (or its admin
   API). It takes effect immediately — no restart required.

A license records its validity dates and which features, limits and quotas the installation has. The
License page shows them together with current usage. See [License and Tiers](/documentation/license).

## What happens if my SelfDocHub instance doesn't have a valid license installed?

The instance still starts. Sign-in and the License page keep working so you can install a license,
but every other endpoint is locked until a valid license is uploaded.

## What happens when I reach a limit of my license?

Only creating more is refused, for example another service, user or team. Existing data is never deleted
or hidden, so a lower limit stops growth without losing anything.

## Can I re-issue a license for a new installation?

Yes — from your dashboard, generate a new license for the new installation's `device_id`. Each
issuance uses one license from your plan's quota, whether it's for a brand-new installation or a
replacement for one you're retiring.

## Where is my documentation data stored?

On your own infrastructure. SelfDocHub instances run inside your environment and we don't have
access to the specifications, documentation, or Try-It requests stored there. This portal only
handles your account, subscription, and license files — see our [Privacy Policy](/docs/privacy-policy)
for details.

## How do plans differ?

Plans differ by limits and features, not by the number of people who read the documentation:

| | Free | Team | Business | Unlimited |
|---|---|---|---|---|
| Price | $0 | $20/month | $100/month | $500/month |
| Installation licenses | 1 | 2 | 5 | 100 |
| Users / teams | 2 / 1 | 20 / 3 | 100 / 30 | no limit |
| Services | 3 | 15 | 200 | no limit |
| Endpoints per service | 50 | 300 | 3,000 | no limit |
| MCP server | 1 token, 20,000 requests/month | 5 tokens, 100,000 requests/month | 20 tokens, 500,000 requests/month | yes |
| Try-It through MCP | no | no | 10,000 requests/month | yes |
| Single sign-on | no | no | yes | yes |
| Notifications | no | yes | yes | yes |
| Export | 20/month | 200/month | 2,000/month | yes |

Every plan supports all spec formats (OpenAPI, GraphQL, OpenRPC, AsyncAPI) and Try-It. Yearly billing
costs the same as ten monthly payments (two months free): $200/year for Team, $1,000/year for Business and
$5,000/year for Unlimited. A license is tied to one installation, and each
plan includes the number of installation licenses shown above, for example for production and staging.
Contact us if you need more. See [License and Tiers](/documentation/license).

## How do I cancel my subscription?

Open the **Subscriptions** page in your dashboard, click **Billing** and cancel the subscription in
the billing portal. The cancellation takes effect at the end of the period you have already paid for:
until then the subscription stays active and you can keep issuing licenses. Licenses you've already
issued keep working until they expire. **When you cancel, the money you have already paid is not
returned**: there are no refunds and no partial refunds for the unused part of the period. See the
[Terms of Service](/docs/terms-of-service).

## Do you offer refunds?

No. Payments are non-refundable, and cancelling a subscription does not return the money already paid
for the current monthly or yearly period. You keep full access until that period ends, and the
subscription is not renewed. If you want to try the product first, use the Free plan. Nothing here
limits rights that mandatory consumer-protection law gives you.

## Who do I contact for help?

Reach us at **support@selfdochub.com** — for general questions, enterprise plans or custom terms.

---
Source: https://selfdochub.com/docs/faq
