Getting Started

Quick Start

Create a new demo database

CLI command

nervatura -c database -o "{\"alias\":\"demo\",\"demo\":true}"

Docker

Create a Docker container and set some options

mkdir data
docker run -i -t --rm --name nervatura \
  -p 5000:5000 -v "$(pwd)"/data:/data nervatura/nervatura:latest

In a new command window:

docker exec -i nervatura /nervatura \
  -c database -o "{\"alias\":\"demo\",\"demo\":true}"

Snap

sudo /snap/nervatura/current/nervatura -c database \
  -o "{\"alias\":\"demo\",\"demo\":true}"

Database path: /var/snap/nervatura/common/demo.db

Windows

& "C:\Program Files\Nervatura\nervatura.exe" -c database -o '{\"alias\":\"demo\",\"demo\":true}'

Default Nervatura data directory: C:\ProgramData\Nervatura\data

Node.js NPM

mkdir data
./node_modules/nervatura/bin/nervatura -c database \
  -o '{\"alias\":\"demo\",\"demo\":true, \"NT_ALIAS_DEMO\": \"sqlite://file:data/demo.db?cache=shared&mode=rwc\"}'

Database drivers

Configure your database connection in your environment variables: NT_ALIAS_[ALIASNAME]

Connection string format: adapter://user:password@host/database or adapter://user:password@host?database=database

Supported database adapters: sqlite, postgres, mysql, mssql

For examples:

  • NT_ALIAS_DEMO=sqlite://data/database/demo.db?cache=shared&mode=rwc
  • NT_ALIAS_PGDEMO=postgres://postgres:password@localhost:5432/nervatura?sslmode=disable
  • NT_ALIAS_MYDEMO=mysql://root:password@localhost:3306/nervatura
  • NT_ALIAS_MSDEMO=mssql://sa:Password1234_1@localhost:1433?database=nervatura

Create a new database:

./nervatura -c database \
  -o "{\"alias\":\"[your_lowercase_alias_name]\",\"demo\":false}"

The SQLite databases are created automatically. Other types of databases must be created manually before. For testing you can fill in the database with some dummy data (demo=true). If you don’t need those later, then you can create a blank database again. All data in the database will be destroyed!

Login to the new database

Start Nervatura Client and login:

Username: admin

Password: The default admin password is the NT_API_KEY environment variable. Please change after the first login!

Database: alias name (e.g. demo)

Optional: Install Nervatura Report templates to the database

  • Settings -> REPORT TEMPLATE menu
  • Here you can see all installable files from the NT_REPORT_DIR directory (empty value: all built-in Nervatura Report templates)
  • Install the selected report templates to the database. You can modify the report templates after installation by the REPORT EDITOR.

Customization

  • Nervatura Client interface language translation

    Create a file based on the example client_labels.json file. All subtitles can be found the original message.json.

    Set NT_CLIENT_LABELS environment variable value to path/to/YOUR_CLIENT_LABELS_FILE.JSON. The default login language and theme can be specified in the query parameter, for example: /client/?lang=es&theme=dark. For more information, see the Examples section code examples.

  • Nervatura Client shortcuts and report template

    It is possible to create shortcuts in the program, which can call remote functions. Input parameters can also be set and the user will be informed about the result.

    The PDF report templates structure, displayed data and language can be modified with the Report Editor extension.

  • Custom PDF Report font

    Set NT_REPORT_FONT_FAMILY environment variable value to YOUR_FONT_FAMILY_NAME. Valid font type and filename form: FAMILY_NAME-Regular.ttf, FAMILY_NAME-Italic.ttf, FAMILY_NAME-Bold.ttf, FAMILY_NAME-BoldItalic.ttf

    Set NT_REPORT_FONT_DIR environment variable value to path/to/YOUR_FONTS_PATH. Docker container: mount local folder to the container.

Previous
Upgrade
Next
Examples