Settings for New Packages
Role: Administrator
Overview
Under Settings, you define the values new packages, meta packages and packages from the assistant From installer … start with, and which mail address changelog entries get when the user has no email. The values apply to all users. Only administrators may change them.
The defaults only take effect when a package is created. Existing packages and imported packages (.opsi or workbench) keep their own values, and every Packager can override the defaults in the package editor.
You do not set up the connection to the opsi config servers here but in the Depots view, see Config servers .
Changing settings
- Open Settings at the bottom of the activity bar.
- Change the values you want in the New packages, Meta packages, Changelog, Workbench, Worker or opsi-setup-detector blocks.
- Click Save in the toolbar. The message “Settings saved” confirms this.
Revert restores the last saved values. Both buttons are only active if you have changed something. If you leave the page with unsaved changes, oPBWeb asks for confirmation.
New packages
oPBWeb enters these values into every package created via New package.
| Field | Default | Allowed values | Effect |
|---|---|---|---|
| Product version | 1.0 | 1–32 characters consisting of letters, digits and . + ~ | Product version of the first version |
| Package version | 1 | 1–16 characters consisting of letters, digits and . + ~ | Package version of the first version |
| Priority | 0 | −100 to 100 | Priority in the control file |
| control format | INI (legacy) | INI (legacy), TOML (control.toml) | Format in which the control file is written into the package |
| Changelog | changelog embedded | changelog embedded, changelog.txt, changelog.md | Whether the changelog is part of the control file or a separate file in the package |
Meta packages
Meta packages bundle several products. They install their products through dependencies (action setup, order before); the setup script itself does nothing. The values apply to the Meta package … dialog in the package list.
| Field | Default | Allowed values | Effect |
|---|---|---|---|
| Product id prefix | meta- | up to 32 characters consisting of lower-case letters, digits and . _ -, may be empty | Suggested value the Product ID field in the dialog is pre-filled with |
| Priority | -100 | −100 to 100 | Priority of the meta package. |
| Setup script name | dummy.opsiscript | 1–128 characters, without / and \ | File name of the empty setup script in CLIENT_DATA |
The product version field in the Meta package … dialog is pre-filled with the Product version from the New packages block.
Changelog
| Field | Default | Allowed values | Effect |
|---|---|---|---|
| Mail domain for users without e-mail | localhost | 1–128 characters | Changelog entries of users without an email address get username@<domain>. |
If a user has entered an Email in their account, oPBWeb uses that address. So enter a domain here that fits your accounts, or maintain the email addresses in Users and roles . For directory accounts, the address comes from LDAP.
Workbench
| Field | Default | Allowed values | Effect |
|---|---|---|---|
| Imported version is installed on a depot but has no .opsi in the project folder | Keep the draft | Keep the draft, Build and release | If the version of a project folder imported from the workbench is installed on a depot of the same config server, oPBWeb takes the file <product-id>_<version>.opsi from the project folder as the build and releases the version. Without that file, the version stays a draft with “Keep the draft”; with “Build and release”, oPBWeb builds it from the imported sources and releases it. |
The setting applies to the import and to the reconciliation in the “Workbench …” dialog (Reconcile with depots), which catches up drafts imported earlier, see Releasing installed versions . In both cases the job log states why a version was released or stayed a draft.
Worker
| Field | Default | Allowed values | Effect |
|---|---|---|---|
| opsi check every (minutes) | 5 | 1–1440 | How often the worker checks all config servers (sign-in, admin rights, CA certificate) and syncs their depots. |
| Read workbench every (minutes) | 60 | 1–1440 | How often the worker reads the workbench of all config servers and records which project folders lie there (also in group folders up to four levels deep, not in ignored folders ); the package list shows this under Workbench . The interval is independent of the opsi check because reading needs two requests to the server per project folder. A server that cannot be reached is skipped. |
| Clean up temporary files at | 03:17 | time of day | Once a day at this time the worker deletes prepared downloads and abandoned uploads older than 24 hours. If the time has already passed when the worker starts, it cleans up right away. |
Changes apply from the next minute; the worker does not need a restart. The interval of the heartbeat (every 30 seconds) cannot be changed: the system status uses it to detect a failed worker.
opsi-setup-detector
These values are the defaults for the assistant Creating a package from an installer . They correspond to the configuration of the opsi-setup-detector. Check boxes and properties are only preset in the assistant; the packager can change them there for every package. Package version, priority, control format and Changelog come from the New packages block.
| Field | Default | Effect |
|---|---|---|
| Template channel | Default | channel preselected in the assistant: Training (verbose comments), Default, Structured or Own (custom), see Templates |
| Libraries (importlib) | empty | one library name per line (at most 20); the generator adds an importlib line for each to the scripts |
| Silent instead of unattended parameters | off | installers run without any window instead of showing their progress |
| Uninstall MSI wrappers through msiexec | on | installers with an embedded MSI uninstall through msiexec /x when the analysis found the ProductCode |
| Preselect the option desktop icon | off | option Desktop icon preselected in the assistant |
| Preselect the option license key property | off | option License key property preselected in the assistant |
| Write metadata (CLIENT_DATA/opsi-meta-data.toml) | off | Windows packages also get the file CLIENT_DATA/opsi-meta-data.toml with product data and installer details, as the opsi-setup-detector writes it |
Own script lines
opsi-script lines the generator inserts into every new package: Before the installation, After the installation, Before the uninstallation and After the uninstallation, each before or after the call of the installer or uninstaller. Empty means: no own lines.
Preset properties
These properties are in every new package of the assistant (at most 50). You create them as in the assistant: Name, Type, Default, Possible values, Description, Free. Properties that belong to the options of the assistant (such as desktopicon) do not need to be entered here; the generator adds them itself.
Template for OPSI/readme.txt
Text of the file OPSI/readme.txt the generator adds to every new package. Empty means: packages get no readme.txt.
Every saved change appears in the Audit log
as settings.updated with the changed fields.