Eviworx
Docs

Quickstart

This guide helps you get productive quickly after installation. It walks you through the key configuration steps — from first login to a fully configured ITSM platform.

⏱️
Estimated time: 15-30 minutes

Prerequisite: All 12 containers are running and "healthy". See Installation.

Phase 1: First Login & Security

1
First Login

URL: https://your-domain.com

Email: admin@company.com

Password: ADMIN_INITIAL_PASSWORD

(Default: ChangeMeNowXx, configurable via ENV)

2
Change Password & MFA

→ User menu → Settings → Security (password)

→ User menu → Settings → Security → Enable MFA (TOTP)

TOTP apps: Google Authenticator, Microsoft Authenticator, Authy

3
🔑 Check / Activate License

→ Admin Center → System → Product License

⏱️ Trial: 30 days, max. 3 agents

Enter License Key + Secret in .env or activate directly in the UI.

License documentation →

Phase 2: Basic Configuration

4
General Settings

→ Admin Center → System → General

  • Set company name
  • Configure application URL (for QR codes, emails)
  • Choose language (DE, EN, ES, FR, IT)
5
Configure Roles

→ Admin Center → Identity & Access → Users / Roles

  • Review system roles: Admin, Agent, Approver, End User, DPO
  • Create custom roles with their own permissions
  • Custom roles are available wherever roles are assigned, e.g. in forms
6
Create Users

→ Admin Center → Identity & Access → Users → New User

  • Create users manually or send invitation email
  • Assign role
  • Optional: Configure agent groups (capacity management)
7
Create Categories

→ Admin Center → Service Configuration → Categories

  • Ticket categories: Hardware, Software, Network, Access...
  • Incident categories (with evidence checklists)
  • Asset categories and AssetType policies

Phase 3: Set Up Communication

8
Configure Email

→ Admin Center → Communication → Email & Mailboxes

  • IMAP/SMTP: Classic email integration
  • Microsoft Graph API: For Microsoft 365 mailboxes
  • Configure email signatures
  • TLS certificate verification (tlsVerify) is on by default; disable only for self-signed certificates
  • Send test email for verification
9
Configure Notifications

→ Admin Center → Communication → Notification Templates (global) · User menu → Settings → Notifications (personal)

  • Channels: Email, Microsoft Teams (Bot Framework), Webex, Web Push
  • Define quiet hours (no notifications e.g. at night)
10
Entra ID SSO (optional)

→ Admin Center → Identity & Access → Microsoft Entra ID

  • Enter Client ID, Tenant ID, Client Secret
  • Configure group-to-role mapping

Phase 4: Set Up ITSM

11
Create First Ticket

→ "Create Ticket" button (or Service Desk → All Tickets)

  • Fill in title, description, category
  • Assign agent
  • Add followers (CC handling)
12
Set Up Workflows

→ Automation → Workflows → Templates → New Template

  • Drag-&-drop editor opens
  • 8 node types: Manual Task, Approval, Automated Action, Notification, Parallel Gateway, Conditional Branch, Data Collection, Timer Event
  • Interrupted automated steps are run again; paused workflows continue only after being resumed
13
SLA Management

→ Admin Center → Service Configuration → SLA & Escalation

  • Define SLA policies (response/resolution times)
  • Configure business hours
  • Define escalation levels
14
Configure CronJobs

→ Automation → CronJobs

  • 28 action types available
  • Scheduled reports, SLA monitor, cleanup jobs
  • Agent workload monitoring

Phase 5: Dashboards & Monitoring

📊
Unified Workplace
Central dashboard with configurable widgets. Your starting point after login.
🖥️
NOC Dashboard
Network Operations Center view for real-time monitoring and incident tracking.
📈
Analytics
Interactive analytics page with reports across all ITSM modules.

Phase 6: Advanced Features

Custom Reports
Create custom reports with the report builder. Scheduled or on-demand. Export as CSV or PDF.
Agent Groups & Capacity
Agent groups with a maximum workload per agent. When an agent reaches the limit, a notification is sent automatically (ASSIGNMENT_CAPACITY_REACHED). A dashboard widget shows the workload.
Incident GDPR Flow
Report data breaches in incidents. Dedicated role: Data Protection Officer (DPO). Evidence checklists per entity.
Asset Handover & Inventory
QR/PDF-based handover processes. Inventory functions with workflow integration and notifications.

Check System Status

The current system status of all containers, health checks and ports can be viewed at:

  • UI: Admin Center → System → System-Status (/admin/system-status)
  • CLI: docker compose ps
  • Backend Health: curl -k https://your-domain.com/api/health/live
💬
Support

Questions? Issues? → info@eviworx.com