Requirements and planning
On this page
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, not only on demand.
Deployment options#
| Option | Runtime needed on the host | Page |
|---|---|---|
| Windows Server with IIS | ASP.NET Core 10.0 Hosting Bundle, Microsoft Visual C++ Redistributable (x64) | Windows (IIS) |
| Linux service (Ubuntu, Debian, RHEL family) behind nginx | ASP.NET Core 10.0 runtime (aspnetcore-runtime-10.0) |
Linux |
| Docker | Docker Engine 20.10+ or Docker Desktop (WSL 2); the image contains the .NET 10 runtime on Ubuntu 24.04 | Docker |
| Kubernetes | A cluster, kubectl, Helm 3 |
Kubernetes |
The release you run decides the .NET version: the current releases target .NET 10 (LTS). Check TargetFramework and the release notes when you upgrade; a newer .NET version means installing its runtime or Hosting Bundle first.
Internal database#
The application keeps its data in an internal database of your choice (Configuration):
| Database | Use |
|---|---|
| SQLite (default) | No database server needed; one application server only. Good for small installations and evaluation. |
| Microsoft SQL Server | Production, also with several servers. |
| PostgreSQL | Production, also with several servers. The Kubernetes chart includes one by default. |
| MySQL | Production, also with several servers. |
The schema is created and migrated automatically at start-up.
Other components#
- SMTP server for e-mails to users and clients (password reset, new users, client e-mails, warnings).
- Identity provider if users should sign in with their company account: Active Directory (Windows/IIS only), LDAP, Microsoft Entra ID, or OAuth (Okta, Google, Microsoft, custom) (Authentication).
- File storage: the server's disk, or Azure Blob, Amazon S3, MinIO, Box, SharePoint, Google Cloud Storage (File storages).
- Cache: in-memory by default; Redis or a database cache for several servers (Running in production).
- HTTPS: required for deployed installations, because the sign-in cookie is sent only over HTTPS. Terminate TLS at IIS, nginx, an ingress or a load balancer.
- Optional: Slack or Microsoft Teams, Számlázz.hu, HashiCorp Vault.
Single server or several#
| Single server | Several servers | |
|---|---|---|
| Database | any (SQLite is fine) | SQL Server, PostgreSQL or MySQL |
| Cache | InMemory | Redis or database cache |
| File storage | server disk or cloud | cloud storage |
| Settings | identical appsettings.json on every server, including the signing keys and PublicBaseUrl |
Browsers and devices#
The portal is a desktop web application for current browsers. It is not optimised for phone screens; phones use the mobile app.
Before go-live checklist#
- [ ] Own signing keys set in
appsettings.json(three keys, see Configuration) - [ ]
PublicBaseUrlset - [ ] HTTPS in front of the application;
SecureCookiestaystrue - [ ] SMTP settings filled in and tested
- [ ] Backups of the database and the data folder scheduled (Upgrading, backup and restore)
- [ ] Licence uploaded, first Super Admin created (Getting started)