Skip to content
nptmpl @ nguyenpanda.com v1.1.0

Documentation

Deploy, configure and operate your nptmpl registry.

โš™๏ธ Configuration Guide

This guide covers all available customization options for nptmpl, both via config.yaml and environment variables.


๐Ÿ” Discovery

You can see all available configuration options directly from your terminal:

nptmpl config --show

This command stays in sync with the codebase and shows exactly what you can customize.


๐Ÿ› ๏ธ Core Configuration

These settings control the fundamental behavior of the CLI and local registry.

YAML Property Env Var Default Description
core.store_path NPTMPL_STORE_PATH ~/.nptmpl/db Where templates and the SQLite DB are stored.
core.auth_token NPTMPL_AUTH_TOKEN N/A Token for remote push/delete operations.
core.ignore N/A [] Global patterns to ignore (e.g., .DS_Store, .venv).
core.public_url N/A N/A The public URL shown in clone instructions.
core.session_secret NPTMPL_SESSION_SECRET Random Key used to sign session cookies (Production recommended).

๐ŸŽจ Web UI Customization

The built-in registry server can be fully white-labeled using the server.ui block.

YAML Property Description
server.ui.title Text shown in the browser tab and site header.
server.ui.logo_text Branding text next to the panda logo.
server.ui.theme_color Tailwind CSS color for accents (see below).
server.ui.author_name Name shown in the "About" section.
server.ui.github_url Link to your GitHub profile.
server.ui.linkedin_url Link to your LinkedIn profile.

๐ŸŒˆ Theme Colors

nptmpl supports any standard Tailwind CSS color. For best results, use the -500 weight.

Commonly Used Values:

  • emerald-500 (Matrix Green) - Highly Recommended
  • blue-500 (Digital Blue)
  • rose-500 (Cyber Pink)
  • violet-500 (Neon Purple)
  • amber-500 (Warning Gold)
  • cyan-500 (Aqua)
  • slate-500 (Neutral Gray)
  • random (picks one entry from the palette)

Note: random is resolved once per server process, not per request. The accent colour stays consistent while you navigate and changes only on restart. Earlier builds re-rolled on every page load, which made the theme flicker.


๐Ÿ” Server Administration

Credentials for the new Web Login Portal and /admin dashboard.

YAML Property Env Var Default Description
server.admin.username NPTMPL_ADMIN_USER admin Login username for the Web UI.
server.admin.password NPTMPL_ADMIN_PASS admin Login password for the Web UI.

๐Ÿณ Deployment-only Environment Variables

These are read directly from the environment and have no config.yaml equivalent.

Env Var Default Description
NPTMPL_SERVER_TOKEN N/A Bearer token for push / rm. Takes precedence over core.auth_token.
NPTMPL_SESSION_SECRET Random Signs /admin session cookies. Set in production or sessions drop on restart.
NPTMPL_SERVER_STORAGE N/A Storage root used by the Docker image and by --reload.
NPTMPL_CONFIG_PATH N/A Explicit config file path; overrides the standard lookup order.
NPTMPL_HOST_PORT 9090 Compose only: host port to publish. Container port stays 9090.
NPTMPL_REINDEX unset Compose only: any non-empty value rebuilds the index on boot.
NPTMPL_ENABLE_DOCS unset Compose only: any non-empty value exposes /api/docs.

See SERVER_SETUP.md for the full path reference and the database layout.


๐Ÿ“ Template Defaults

Default metadata used when running nptmpl init.

YAML Property Description
defaults.author Your default name.
defaults.email Your default email.
defaults.license Default license (e.g., MIT).