Skip to content

Install ​

Codevibe Sign is a set of TypeScript packages. You can embed them in your own Node backend, or run the standalone service as a Docker image. Either way the documents, keys and personal data stay on your servers.

Try it in a minute ​

sh
npx codevibe-sign start --memory

This starts the server with everything in memory: a generated seal certificate, emails and one-time codes printed to the terminal, and a fresh API key. It prints a curl command that sends a PDF for signature. Open the signing link from the output, sign, download the sealed file and check it:

sh
npx codevibe-sign verify signed.pdf

Nothing is saved when it stops. For a walk-through of the API, see Send your first envelope.

Pre-release

The packages are not published to npm yet; build them from the repository as shown below. APIs may still change before 0.1.

Requirements ​

  • Node 20 or later.
  • PostgreSQL, for the server.
  • An SMTP server for invitations and one-time codes, and an SMS gateway if you use SMS codes.
  • A sealing certificate and key as a PKCS#12 (.p12) file. See Sealing and verification. For development, npx codevibe-sign keygen --out seal.p12 makes a self-signed one.

start --memory needs only Node: no database, mail server or certificate.

Choose how to run it ​

You want toUse
Run signing as its own service and call it over HTTPSelf-host with Docker
Run the same service without Dockernpx codevibe-sign start, with the same variables
Start the server inside your existing Node appEmbed in Node
Use the signing rules only, with your own storage and transport@codevibe_technology/sign-core
Show the signing screen inside your React app@codevibe_technology/sign-react
Add Aadhaar eSign for statutory signatures in India@codevibe_technology/sign-aadhaar

Install the packages ​

Most projects need one package:

sh
npm i codevibe-sign

It brings the server, client, PDF tools and core rules behind subpath imports, so each bundle only carries what it uses, plus the codevibe-sign command line:

ts
import { startSignServer } from 'codevibe-sign/server';
import { createSignClient, verifyWebhook } from 'codevibe-sign/client';
import { verify } from 'codevibe-sign/pdf';
import type { Envelope } from 'codevibe-sign/core';

For the React components, add React: npm i codevibe-sign react react-dom, then import from codevibe-sign/react.

You can also install the parts on their own:

sh
# The server, with core and pdf as dependencies
pnpm add @codevibe_technology/sign-server

# The rules on their own
pnpm add @codevibe_technology/sign-core

# React components for the signing screen
pnpm add @codevibe_technology/sign-react react react-dom

# Aadhaar eSign through your provider account
pnpm add @codevibe_technology/sign-aadhaar @codevibe_technology/sign-core

npm and yarn work the same way.

Build from source ​

Until the first release, build the packages from the repository:

sh
git clone https://github.com/codevibe-technology/codevibe-sign.git
cd codevibe-sign
pnpm install
pnpm build

Next ​

Libraries under Apache-2.0, server and apps under AGPL-3.0. "Codevibe", "Codevibe Sign" and "Hrvibe" are trademarks of Codevibe Technology and are not covered by the licences.