﻿# Documentation

> Everything about using, configuring, installing and running WorkSmartHub: features with screenshots, guides by role, installation on Windows, Linux, Docker and Kubernetes, and the API.

Source: https://workwise-solutions.net/docs/ · Language: en · Hungarian version: https://workwise-solutions.net/hu/docs/

## Start here

- [Overview](https://workwise-solutions.net/docs/overview/): WorkSmartHub is a work management platform. Companies use it to record and follow jobs (repairs, maintenance, installations, quotes, deliveries) as work tickets, to keep their client and stock records in one place,…
- [Permissions and roles](https://workwise-solutions.net/docs/permissions-and-roles/): WorkSmartHub has two layers of permissions:
- [Getting started](https://workwise-solutions.net/docs/getting-started/): This page takes a new installation from the first start to the first work ticket. It assumes the application is installed and reachable in a browser (Installation) and that you are the person who will be the first…

## Features

- [Workspaces](https://workwise-solutions.net/docs/features/workspaces/): A workspace (munkaterület) is a separated area for one team, department or project. It has its own access rules, its own work tickets, and optionally its own notification channels and file storages. Users of one…
- [Work tickets](https://workwise-solutions.net/docs/features/work-tickets/): A work ticket (munkajegy) records one job from intake to completion: who the client is, what product or service it is about, what is wrong, who works on it, what was used and done, how it is delivered, and in which…
- [Clients](https://workwise-solutions.net/docs/features/clients/): Clients (ügyfelek) are the customers your work tickets belong to. The client list is shared by all workspaces.
- [Manufacturers and ticket options](https://workwise-solutions.net/docs/features/manufacturers-and-ticket-options/): Several fields of a work ticket are chosen from lists maintained by administrators. These lists are shared by all workspaces. Users who work on tickets can pick from them without the permissions below; the…
- [Acting works and deliveries](https://workwise-solutions.net/docs/features/acting-works-and-deliveries/): Acting works and deliveries are price lists that tickets use for their costs. Together with components they make up the total cost on the ticket summary.
- [Warehouse (components)](https://workwise-solutions.net/docs/features/warehouse/): The warehouse (Raktárkészlet) keeps the components (komponensek) you use on jobs: spare parts, consumables, devices. Each component has a quantity in stock and a price. Components added to work tickets are taken from…
- [Invoices with Számlázz.hu](https://workwise-solutions.net/docs/features/invoices-szamlazz-hu/): WorkSmartHub can issue invoices for work tickets through Számlázz.hu, the Hungarian online invoicing service. The invoices are created in your Számlázz.hu account; WorkSmartHub keeps a copy of their status and PDF,…
- [Notification channels and templates](https://workwise-solutions.net/docs/features/notifications/): WorkSmartHub notifies users about events, for example when a ticket's status changes, when they are assigned to a ticket, or when their personal access token is about to expire. Notifications are sent through…
- [File storages](https://workwise-solutions.net/docs/features/file-storages/): File storages (fájltárolók) decide where WorkSmartHub keeps ticket attachments and component images. You can use the server's own disk or a cloud service.
- [Audit, error audit and log files](https://workwise-solutions.net/docs/features/audit-and-logs/): WorkSmartHub records what users do, which errors happen, and what the server writes to its log files. The pages are under Események & Naplófájlok (Events & log files).
- [Personal access tokens](https://workwise-solutions.net/docs/features/personal-access-tokens/): A personal access token (PAT) lets scripts and integrations call the WorkSmartHub REST API in the name of a user. A PAT is a pair:
- [Service user catalog](https://workwise-solutions.net/docs/features/service-user-catalog/): Integrations and business processes often use service users: technical accounts, passwords or API tokens of other systems. Kept in personal notes or spreadsheets, they become a security risk, and an expired password…
- [User management](https://workwise-solutions.net/docs/features/user-management/): Who can sign in, and with which application permissions, depends on the user store configured in appsettings.json (Authentication):
- [Profile and password](https://workwise-solutions.net/docs/features/profile-and-password/): What the sign-in page offers depends on the configured login method (Authentication):
- [Licence](https://workwise-solutions.net/docs/features/licence/): WorkSmartHub needs a licence file from WorkWise Solutions. The licence is stored in the application database, so it survives restarts and upgrades, and every server of a multi-node installation uses the same licence.
- [App configuration](https://workwise-solutions.net/docs/features/app-configuration/): Alkalmazás → App Konfiguráció (Alkalmazás konfiguráció) holds the settings that administrators change while the application runs. It is available to Super admins only. Settings that are needed at start-up (database,…
- [Status page](https://workwise-solutions.net/docs/features/status-page/): Alkalmazás → Státusz shows technical information about the running application and about the signed-in user. It helps when you report a problem or check an installation.
- [Mobile app activation](https://workwise-solutions.net/docs/features/mobile-app/): When the licence includes the mobileApplication feature, the menu has a Mobil Alkalmazás (Mobile app) item. It opens the dialog Mobil alkalmazás beállítása (Set up the mobile app) with a QR code: scan it with the…

## Guides by role

- [Super Admin](https://workwise-solutions.net/docs/guides/super-admin/): The Super Admin (application administrator) is responsible for the whole installation. This guide lists the tasks in the order you usually need them. The first steps are on Getting started.
- [Workspace administrator](https://workwise-solutions.net/docs/guides/workspace-admin/): As a workspace administrator (Munkaterület Admin) you are responsible for one team's workspace: who works in it, how they are notified, where files are stored, and all of its tickets.
- [Ticket administrator and technician](https://workwise-solutions.net/docs/guides/ticket-admin-and-technician/): You record new jobs, keep the tickets complete, and close them.
- [Client-facing flows](https://workwise-solutions.net/docs/guides/client-facing-flows/): Clients do not sign in to WorkSmartHub. They meet the application through printouts and e-mails. This page shows what a client receives during a typical job and what you need for it.
- [Setting up Slack and Microsoft Teams](https://workwise-solutions.net/docs/guides/slack-and-teams/): Besides e-mail, notification channels can send direct messages in Slack and Microsoft Teams. The application has built-in, shareable step-by-step guides with screenshots of the provider's pages:

## Installation and operations

- [Requirements and planning](https://workwise-solutions.net/docs/installation/requirements/): WorkSmartHub is one web application: the ASP.NET Core server serves the API and the Angular portal on the same address and port. Background jobs run inside the same process, so the application must run permanently,…
- [Windows (IIS)](https://workwise-solutions.net/docs/installation/windows-iis/): IIS hosts WorkSmartHub in-process: it manages the process and acts as the reverse proxy, so no separate Windows service is needed. Because the background jobs run inside the web process, IIS must keep that process…
- [Linux (systemd and nginx)](https://workwise-solutions.net/docs/installation/linux/): The application runs as a systemd service under a dedicated user, with nginx as the reverse proxy. The commands are for Ubuntu and Debian; the Red Hat family (RHEL, CentOS Stream, Rocky, Alma, Oracle Linux)…
- [Docker](https://workwise-solutions.net/docs/installation/docker/): The Docker image runs the whole application (server and portal) on port 8080 as the non-root user appuser (uid 1001). It is based on the ASP.NET Core 10.0 runtime on Ubuntu 24.04 LTS, so the host needs no .NET runtime.
- [Kubernetes](https://workwise-solutions.net/docs/installation/kubernetes/): WorkSmartHub ships a Helm chart (worksmarthub) in the WorkSmartHub-Docker-Kubernetes repository. Its operator guide (English, Magyar) walks through twelve steps, from the namespace to the licence, plus upgrade,…
- [Docker and Kubernetes operator guide](https://workwise-solutions.net/docs/installation/operator-guide/): This repository builds the WorkSmartHub container image and runs it with Docker or on Kubernetes, and this document is the operator guide for both. WorkSmartHub (by WorkWise Solutions) is one web application: the…
- [Configuration (appsettings.json)](https://workwise-solutions.net/docs/installation/configuration/): Settings needed at start-up live in appsettings.json in the application folder (in Docker: mounted to /app/appsettings.json). The file is commented. Settings that administrators change at run time are in App…
- [Authentication options](https://workwise-solutions.net/docs/installation/authentication/): Two settings in appsettings.json decide how users sign in:
- [Upgrading, backup and restore](https://workwise-solutions.net/docs/installation/upgrade-backup-restore/): In Docker and Kubernetes everything except appsettings.json is on the data volume (/app/data). Cloud file storages are backed up at the provider.
- [Running in production](https://workwise-solutions.net/docs/installation/operations/): These notes apply to every deployment type and every database.

## Reference

- [API usage](https://workwise-solutions.net/docs/api-usage/): Everything the portal does goes through the WorkSmartHub REST API, so integrations can do the same: create tickets from another system, read statuses into a report, synchronise components, and so on.
- [Troubleshooting and FAQ](https://workwise-solutions.net/docs/troubleshooting-faq/): Every page opens the licence page. The application has no valid licence (none, expired or corrupted). Upload a licence file; no sign-in is needed while there is no valid licence (Licence).
- [Release notes](https://workwise-solutions.net/docs/release-notes/): The changes of every WorkSmartHub release (new features, fixes, and the steps an upgrade needs) are published in the WorkSmartHub-Changelog repository, in the file changelog.html. The changelog is written in Hungarian.

WorkSmartHub helps companies run their day-to-day work: service jobs, repairs, installations, deliveries and everything else that is recorded as a **work ticket** (*munkajegy*). Teams work in separate **workspaces** (*munkaterületek*) with their own permissions, notification channels and file storages. Shared master data such as clients, manufacturers, components and work steps is maintained once and used by every workspace.

This wiki describes how the product works, for users, administrators and operators. The application interface is Hungarian; in this English version every control is named by its Hungarian label followed by the English meaning, for example **Munkajegyek** (Work tickets).

![The introduction page after signing in](https://workwise-solutions.net/docs/images/overview-introduction.png)
*The introduction page (Bevezetés) after signing in. The left menu shows only the pages you have permission for.*

## Where to start

| You are… | Read |
|---|---|
| New to WorkSmartHub | [Overview](https://workwise-solutions.net/docs/overview/), then [Permissions and roles](https://workwise-solutions.net/docs/permissions-and-roles/) |
| Setting up a new installation | [Requirements](https://workwise-solutions.net/docs/installation/requirements/), the installation page for your platform, then [Getting started](https://workwise-solutions.net/docs/getting-started/) |
| The application administrator (Super Admin) | [Super Admin guide](https://workwise-solutions.net/docs/guides/super-admin/), [App configuration](https://workwise-solutions.net/docs/features/app-configuration/) |
| Responsible for one team | [Workspace administrator guide](https://workwise-solutions.net/docs/guides/workspace-admin/) |
| Working on tickets every day | [Ticket administrator and technician guide](https://workwise-solutions.net/docs/guides/ticket-admin-and-technician/), [Work tickets](https://workwise-solutions.net/docs/features/work-tickets/) |
| Integrating another system | [API usage](https://workwise-solutions.net/docs/api-usage/), [Personal access tokens](https://workwise-solutions.net/docs/features/personal-access-tokens/) |
| Running the server | [Running in production](https://workwise-solutions.net/docs/installation/operations/), [Upgrading, backup and restore](https://workwise-solutions.net/docs/installation/upgrade-backup-restore/) |

## Main areas of the application

- **[Work tickets](https://workwise-solutions.net/docs/features/work-tickets/)**: the jobs themselves, with client, product, status, assigned people, components, acting works, delivery, attachments, a calendar view and printable summaries.
- **[Clients](https://workwise-solutions.net/docs/features/clients/)**: the customers the tickets belong to, with their ticket history.
- **[Master data](https://workwise-solutions.net/docs/features/manufacturers-and-ticket-options/)**: manufacturers and product types, guarantors, ticket types and work types, [acting works and deliveries](https://workwise-solutions.net/docs/features/acting-works-and-deliveries/), and the [warehouse](https://workwise-solutions.net/docs/features/warehouse/).
- **[Invoices](https://workwise-solutions.net/docs/features/invoices-szamlazz-hu/)**: optional invoicing through Számlázz.hu.
- **[Notifications](https://workwise-solutions.net/docs/features/notifications/)** and **[file storages](https://workwise-solutions.net/docs/features/file-storages/)**: per workspace or for the whole application.
- **Administration**: [users and groups](https://workwise-solutions.net/docs/features/user-management/), [app configuration](https://workwise-solutions.net/docs/features/app-configuration/), [audit and logs](https://workwise-solutions.net/docs/features/audit-and-logs/), [licence](https://workwise-solutions.net/docs/features/licence/), [status](https://workwise-solutions.net/docs/features/status-page/).

## Other resources

- Built-in documentation: the **Bevezetés** (Introduction) and **Kezdő Lépések** (Getting started) pages inside the application.
- Docker and Kubernetes operator guide: [WorkSmartHub-Docker-Kubernetes](https://workwise-solutions.net/docs/installation/operator-guide/) ([English](https://workwise-solutions.net/docs/installation/operator-guide/), [Magyar](https://workwise-solutions.net/hu/docs/installation/operator-guide/)).
- [Release notes](https://workwise-solutions.net/docs/release-notes/).
