AuthOS documentation

Start here with AuthOS

AuthOS is a self-hosted authentication and authorization platform for multi-tenant applications. These guides help evaluators, application teams, self-hosting operators, tenant administrators, and platform owners reach the right first result.

Choose your getting-started goal Understand the architecture

Beta · pre-1.0 SDKs. Pin exact versions and review project status before production use.

AuthOS release 0.8.2 API v1 TypeScript SDK 0.8.0 Latest-only documentation

Getting started

Choose the outcome you need now

Each goal starts with prerequisites, a time estimate, a completion check, and one clear next step.

Evaluator · 20–30 min

Evaluate

Run the standalone SQLite bundle and confirm a healthy local AuthOS instance before choosing an integration.

Evaluate AuthOS locally

Frontend or backend integrator · 15–40 min

Integrate

Connect an existing React, Vue, browser, or Node.js application, or authorize a service workload.

Integrate a frontend Integrate a backend or service

Self-hosting operator · 30–60 min

Deploy

Choose SQLite, PostgreSQL, or MySQL and prepare keys, public origins, health checks, and runtime configuration.

Plan a self-hosted deployment

Administrator or platform owner · 20–45 min

Operate

Manage one tenant or govern the full platform through organization, audit, analytics, and maintenance controls.

Administer a tenant Operate the platform

Integration proof

Use the adapter that fits your application

Official TypeScript packages provide focused entry points for React, Vue, Node.js, and framework-agnostic browser apps. The integration guides explain the complete flow; these examples show the shape of the client code.

Read the React package guide

App.tsx

import { AuthOSProvider, SignIn } from
  '@drmhse/authos-react';

export function App() {
  return <AuthOSProvider baseURL={authURL}>
    <SignIn />
  </AuthOSProvider>;
}

npm install @drmhse/authos-react

main.ts

import { createApp } from 'vue';
import { AuthOSPlugin } from
  '@drmhse/authos-vue';

createApp(App)
  .use(AuthOSPlugin, { baseURL: authURL })
  .mount('#app');

npm install @drmhse/authos-vue

server.ts

import { createAuthMiddleware } from
  '@drmhse/authos-node/express';

const { requireAuth } = createAuthMiddleware({
  baseURL: authURL
});
app.get('/account', requireAuth(), handler);

npm install @drmhse/authos-node

auth.ts

import { SsoClient } from '@drmhse/sso-sdk';

const auth = new SsoClient({
  baseURL: authURL
});

await auth.auth.login({ email, password });

npm install @drmhse/sso-sdk

Before you begin

Match the path to your environment

Bring the right prerequisites

Evaluation and deployment require a Linux host and shell access. Application integration requires Node.js 18+, npm, and a reachable AuthOS base URL. Administration paths require the corresponding tenant or platform access.

Choose a deployment boundary

SQLite is the shortest evaluation and single-node path. PostgreSQL and MySQL use database-specific binaries for operated deployments. If AuthOS already runs, skip installation and start with integration or operation.

Know when you are done

Every getting-started guide ends with a concrete completion check and points into the next guide, concept, API reference, or SDK reference for your selected journey.