Installation Guide

This guide walks you through installing DocuMan on a Windows server or workstation.

Prerequisites

  • Operating System: Windows Server 2019+ or Windows 10/11 (64-bit)
  • Database: PostgreSQL 18 installed and running
  • Memory: 4 GB RAM minimum, 8 GB recommended
  • Privileges: Administrator account (required for installation and service registration)

Step 1: Download the Installer

Download JimRan-DocuMan-Setup-v26.4.2.exe from jimran.com/download.html.

Step 2: Run as Administrator

Right-click the installer and select Run as administrator. The installer requires elevated privileges to register Windows services.

Step 3: Choose Installation Type

The installer offers two options:

  • Full (with Tesseract): Includes the Tesseract OCR engine for automatic text extraction from scanned documents. Recommended for most installations.
  • Compact: Installs the core application only, without OCR support. Use this if you don't need text extraction or already have Tesseract installed separately.

Step 4: Installation Completes

The installer copies application files to the selected directory and registers the DocuMan services with Windows. No manual service configuration is required.

Step 5: Configure the Environment File

Open the .env file in the DocuMan installation directory and configure your PostgreSQL connection:

DB_HOST=localhost
DB_PORT=5432
DB_USER=documan
DB_PASSWORD=your_secure_password
DB_NAME=documan

Set these values to match your PostgreSQL installation. The database user must have permission to create tables and functions.

Step 6: Run Database Migrations

Open a command prompt and run the database migration script to create the required tables and functions:

cd C:\DocuMan
psql -h localhost -U documan -d documan -f migrations\001_initial.sql
psql -h localhost -U documan -d documan -f migrations\002_ocr.sql
psql -h localhost -U documan -d documan -f migrations\003_audit.sql

Enter your PostgreSQL password when prompted. Each migration should complete without errors.

Step 7: Start Services

The installer registers four Windows services and starts them automatically. They are set to Automatic startup, so they come back up on every reboot. You can verify or manage them in any of these ways:

  • Quick status check: python service\install_services.py status — lists all four DocuMan services with their current state.
  • Windows Services console: Press Win+R, type services.msc, and look for services prefixed with JimRan DocuMan.
  • PowerShell (as administrator): Get-Service -Name 'JimRanDocuMan*'

See Services & Processes for full details on managing, restarting, and troubleshooting the services.

Step 8: Open DocuMan

Open your web browser and navigate to:

https://localhost

You should see the DocuMan login page. If you get a certificate warning, this is expected — DocuMan uses a self-signed certificate by default.

Step 9: First Login

Log in with the default administrator credentials:

  • Username: admin
  • Password: admin123

Important: Change the default password immediately after your first login. Go to the user menu and select Change Password.

Next: Getting Started — your first 10 minutes with DocuMan.

☕ Buy Me a Coffee