Panoptes LogoPanoptes

Installation Guide Guía de Instalación

Get Panoptes SDK running in minutes. Choose your package manager and database driver. Haz que Panoptes SDK funcione en minutos. Elige tu gestor de paquetes y driver de base de datos.

Prerequisites Prerequisitos

Node.js 18+Node.js 18+ node --version

Package manager (npm / pnpm / yarn) Gestor de paquetes (npm / pnpm / yarn)

Database driver (pg, mysql2, mssql, sqlite3, oracledb) Driver de BD (pg, mysql2, mssql, sqlite3, oracledb)

bash
npm install @panoptes/sdk

Database Quickstarts Inicios Rápidos por BD

Select your database to see the driver install and a minimal audited query. Elige tu base de datos para ver la instalación del driver y una consulta auditada mínima.

PostgreSQLDriver install:Instala el driver:
bash
npm install pg
javascript
import { initAudit, createAuditedPostgresClient, setUserContext } from '@panoptes/sdk';
import { Client } from 'pg';

initAudit({ appName: 'my-app', transports: { enabled: ['console', 'database'] } });

const client = new Client({ host: 'localhost', database: 'myapp', user: 'postgres', password: process.env.DB_PASSWORD });
const db = createAuditedPostgresClient(client, { host: 'localhost', database: 'myapp' });
await db.connect();

setUserContext({ actorType: 'USER', appUserId: 123, appUsername: 'john.doe' });
await db.query('UPDATE users SET email = $1 WHERE id = $2', ['new@example.com', 123]);

Next Steps Próximos Pasos

Now that you've installed Panoptes, continue to the Configuration Guide to customize it for your needs. Ahora que has instalado Panoptes, continúa a la Guía de Configuración para personalizarlo según tus necesidades.

Continue to Configuration Guide Continuar a Guía de Configuración
Learn how to configure Panoptes for your environment Aprende cómo configurar Panoptes para tu ambiente