Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.27 KB

README.md

File metadata and controls

75 lines (50 loc) · 3.27 KB

KeyForge

Self-hosted licensing for your software.

KeyForge is an MIT-licensed license server with an admin console, REST API and TypeScript SDK. Run it on your own infrastructure with SQLite or PostgreSQL.

  • Product catalog, plans, entitlements and license issuance.
  • Activations, trials, offline tokens and optional device recognition.
  • Sales, payments, customer support and financial reports.
  • Operator permissions, audit history and encrypted backups.

Live app · Online documentation · Source releases

Getting started

Requirements

Create a project

Use this template or generate a configured deployment with the CLI.

vp create keyforge@latest

Use Up/Down and Enter to choose a database, starting plans and deployment target, or Ctrl+C to cancel. See the CLI guide, or run the generator from source:

git clone https://github.com/zdevzone/keyforge.git
cd keyforge
vp node packages/create-keyforge/bin/create-keyforge.mjs ../my-license-server --template .

Follow the generator's printed steps or the setup guide to configure secrets, create an administrator and start the server. The console runs at http://localhost:4100; docs are served at /docs.

Packages

Published on npm; GitHub source releases are separate from package versions.

Package Purpose
@zdevzone/keyforge-client TypeScript SDK for dependent apps.
create-keyforge Generate a self-hosted server project.
create-keyforge-client Generate a Node.js client integration starter.

See publishing and beta testing for release channels.

Development

Build output is generated, not tracked. Run vp run build:all before deployment. For cPanel, explicitly include prebuilt dist/; see the deployment guide.

vp install --frozen-lockfile
vp run check
vp run test
vp run build:all

For UI development, run vp -C ui run dev alongside the server. See contributing for details.

Documentation

License

MIT. Self-hosted for one company managing multiple products. Hosted multi-tenant SaaS is not included.