documentation

Get started with Spectrum step by step

Choose the guide for your edition. Run Portable on your own computer or deploy Server on company infrastructure. Both editions are used in a browser. You will also find technical requirements and instructions for activation without internet access.

Environment variables

These variables configure startup. Portable uses defaults and usually needs no changes. For Server, pass configuration through container variables or mounted secret files.

variableeditionmeaning
WEBCON_LICENSEbothlicence key WCR1.…. An alternative to pasting it in Settings; the variable takes precedence.
WEBCON_LICENSE_FILEbothpath to a key file, e.g. a Secret mounted in the container.
WEBCON_LICENSE_SERVERbothlicence server URL; default: https://licencje.viewer-pro.pl. Change only for an internal proxy.
WEBCON_LICENSE_OFFLINEboth1 disables licence server connections; verification is read from the lease file (offline mode).
WC_PG_URLserverPostgreSQL connection URL, e.g. postgres://viewer:haslo@pg.firma.local:5432/viewer_pro. Required to start the Server edition.
WEBCON_SECRET_KEYserversecret vault key (SQL profile passwords, AI keys): 32 random bytes in base64. Alternatively, WEBCON_SECRET_KEY_FILE with a path. Changing the key makes saved secrets unreadable; they must be entered again.
PORTserverHTTP port; default: 8080. OpenShift supplies it automatically.
WEBCON_DBportableapplication data directory. Default: %LOCALAPPDATA%\ViewerPro on Windows and ~/.local/share/viewer-pro on Linux and macOS.

Requirements

PortableServer
operating systemWindows 10/11 x64, Linux x64, macOS (Apple Silicon)OpenShift 4.x, Kubernetes 1.25+ or Docker / Podman
databaseincluded; no separate installation neededPostgreSQL meeting the edition's requirements; database setup
browserChrome, Edge, Firefox, Safari — current versions
memory2 GB of free memory as a starting point; requirements depend on configuration sizesize container and database resources according to configuration size and user count
diskspace for configuration, history and backups; determine capacity during the pilot based on environment count and history retention
networkHTTPS to the licence server daily or an offline lease file; MS SQL if using profiles; AI provider if descriptions are enabled

Command line

Both editions support the same commands. In Portable, run them through the start script; in Server, inside the container using oc exec or docker exec.

# import kompletu paczek jako nowy punkt w czasie srodowiska DEV w workspace KLIENT
viewer-pro ingest import "C:\eksport\*.bpe" --workspace KLIENT --env DEV

# pobranie stanu z profilu MS SQL zapisanego w Ustawieniach (nowy punkt w czasie)
viewer-pro sql import --env PROD

# licencja: zadanie offline i wczytanie dzierzawy
viewer-pro sql license-request > viewer-pro-request.json
viewer-pro sql license-lease viewer-pro-lease.json

Plan limits

In the Server edition, the plan for companies specifies the number of active users, while the plan for WEBCON partners sets the number of clients. One client corresponds to one workspace. Portable has separate limits shown in the table. A user counts when their active account has access or administrator permissions and has signed in within the last 90 days. A workspace counts after the first snapshot is saved in any of its environments.

planintended forusersworkspacesenvironments
Portableone person114
Server 5company51unlimited
Server 20company201unlimited
Server unlimitedcompanyunlimited1unlimited
Partner 5WEBCON partnerunlimited5unlimited
Partner 15WEBCON partnerunlimited15unlimited
Partner unlimitedWEBCON partnerunlimitedunlimitedunlimited
trial (30 days)both editionsunlimitedunlimitedunlimited

After reaching the limit, the software prevents adding another account, workspace or environment and displays a message. Existing data remains accessible. Disabling an account or 90 days without sign-in frees a user slot. After a downgrade, workspaces above the limit cannot accept new snapshots, but their history remains readable. Request an upgrade quote.

Updates and data retention

Before updating, back up PostgreSQL (Server) or the data directory with the application stopped (Portable). Follow the instructions included with the release. Saved snapshots remain available. Returning to an older version requires restoring a pre-update backup; do not run it against data updated by a newer release.