DocKing - ShipSaaS
Docking GitHub
  • DocKing from ShipSaaS
  • Architecture
  • Requirements
  • PDF Engines
    • Gotenberg
    • WkHTMLtoPDF
    • mPDF
  • Upgrade Notes
    • v1.4.0
    • v1.3.2
    • v1.3.1
    • v1.3.0
    • v1.2.0
    • v1.1.2
    • v1.1.1
    • v1.1.0
  • Usage
    • Basic
    • Endpoints
    • Webhook
    • Maintain IDs/Keys from Services
  • Getting Started
    • Environment Variables
    • Run on Local
      • Normal Run
      • Docker
    • Storage
    • Console UI
    • Document Template
      • Gotenberg's Metadata
      • wkHTMLtoPDF's metadata
      • mPDF's metadata
    • Templating Mode
    • Fonts
    • Octane / High-perf mode
    • Localization
  • Deployment
    • Linux VPS / Dedicated Server
    • Docker
Powered by GitBook
On this page
  • Enable Console
  • The Path
  • The Looks
  • The Basic Authentication
  • The Features
  1. Getting Started

Console UI

The internal management Console UI

PreviousStorageNextDocument Template

Last updated 1 year ago

The built-in Console UI with help you manage your templates and check out the rendered files.

It is super helpful for every environment.

However, it is recommended to use the Console UI internally. Requiring users to connect to the internal VPN is a good choice.

Don't expose DocKing to the outside world.

Enable Console

From .env, set this env to true:

DOCKING_CONSOLE_ENABLED=true

Additionally, you might want to set a password:

DOCKING_CONSOLE_PASSWORD=SETH

The Path

  • Path: /console

    • On local: http://localhost:8000/console

The Looks

With preview options. Note: save before preview.

The Basic Authentication

It is recommended to set it in staging or production.

A login page will be shown on the first access.

The Features

  • CRUD Document Templates

    • With preview HTML

      • Good to preview dynamic variables rendering

      • Bad for styling preview

    • With preview PDF (browser printing preview or render a REAL PDF mode)

  • Listing all rendered files

From , you can set the DOCKING_CONSOLE_PASSWORD - a fixed password in order to login into the Console UI.

Environment Variables