Automated PaperCut Server Deployment
This article discusses automating the deployment and installation of the PaperCut Application Server on multiple servers. It is intended to be read by IT System Administrators that will be installing PaperCut NG/MF automatically on multiple independent servers, however it may also be a good reference if you are intending to install PaperCut on a headless server like Windows Server Core.
For information about automating the PaperCut Client deployment using methods such as zero-install, please consult the manual. There is also a section about automating a Secondary Print Server installation. To automate or upgrade Site Servers, check out the steps in the FAQ here.
PaperCut has been deployed on a state-wide and district-wide basis in a number of regions. Some of these deployments have involved a progressive or simultaneous roll-out across thousands of sites and networks. PaperCut provides a number of automated and pre-configured install mechanisms to help maintain a common and consistent server environment. This includes:
- Installer command-line options to define install paths, install options, and automatically trigger installation without the need for an interactive
- The ability to automatically install the license during the install process.
- A mechanism to automatically pre-populate the configuration wizard with various defaults such as costs, user import settings, etc.
The following batch file will automatically start the PaperCut NG installer installing into C:\Program Files\PaperCut MF. Feel free to customize that path if you would like a different installation directory, or if this is PaperCut NG.
REM Installing PaperCut pcng-setup.exe /TASKS="full" /SILENT /DIR="C:\Program Files\PaperCut MF" REM Installation complete. REM Open browser to http://localhost:9191/ to complete configuration. pause
There are different types of installations from the main executable used to install PaperCut. One of the following 4 must be selected. (Please note that multiple installation types can’t be specified within one installation.):
Some other command line switches include:
If the supplied digitally signed license file is renamed to
application.license and placed in the same directory as the
pcmf-setup.exe installer, the file will be detected and automatically installed. This is useful as it avoids the need to manually install the license after the initial configuration. If a license is not supplied, the software will be installed in 40-day trial mode and can be licensed later.
After PaperCut NG/MF is installed for the first time and a web browser is opened, the system will enter the initial configuration wizard (this does not apply to upgrades). The configuration wizard can be pre-populated avoiding the need to complete the full wizard and/or help guide the user in selecting the correct options that match your given SOE.
To pre-populate the setup wizard, create a plain text file called
Windows (any PaperCut version) and Linux (PaperCut version 19.1.0 and above):
setup-defaults.properties file in in the same directory as the
Linux (PaperCut version prior to 19.1.0):
- Run the Linux installer as normal, but answer no to “Would you like to perform these tasks now”
- After the installer is finished copy the file
setup-defaults.propertiesto the application directory
- As the root user run the script
/usr/local/papercut/MUST-RUN-AS-ROOTto complete the installation.
Use the following file format to define the defaults:
# # The default admin password. This password will be one-way encrypted and then stored # in the [app-path]\server\server.properties during the installation process. # admin-password=testing # # The type of your organization. Set to one of the following: # Educational # Commercial # Professional # org-type=Educational # # Set to Y if the print control module should be enabled. # enable-print-module=Y # # Set to Y if the internet control module should be enabled. # enable-net-module=N # # The default color page cost defined initially on all printers. # Set if the print control module is enabled. # print-default-color-page-cost=0.10 # # The default grayscale page cost defined initially on all printers. # Set if the print control module is enabled. # print-default-grayscale-page-cost=0.05 # # The default internet cost per Mb. # Set if the Internet control module is enabled. # net-default-mb-cost= # # The default internet time cost. # Set if the Internet control module is enabled. # net-default-time-cost= # # The default internet time interval in seconds. # Set if the Internet control module is enabled. # net-time-interval-seconds= # # The starting credit assigned to all users. # initial-user-credit=10.00 # # Set to Y if all users should be initially restricted. # users-initially-restricted=Y # # Define the user import/sync source. Options include: # WIN_AD = Windows Active Directory # WIN_STD = Windows Standard # UNIX_PAM = Unix Standard # MAC_PAM = Mac Standard # user-sync-source-type=WIN_STD # # Set to Y if users should be imported from a group rather than # the whole domain (default). # user-sync-import-from-group=N # # By default, the User/Group Sync Source displays all groups in the domain. # If the user source is WIN_AD, this option may be modified to only list groups # from a particular organization unit. # e.g: myorganization.local/Import OU/Sub Import OU # user-sync-ad-group-ou-filter= # # The name of the import group. Set only if the import-from-group # option is selected. user-sync-source-group= # # If the user source type is WIN_AD, this option may be used to # define multiple domains as user sources. This value should be # a semicolon (;) separated list of domains. e.g. # mydomain1.com;mydomain2.com # user-sync-ad-multiple-domains= # # Set to Y if the configuration wizard will be displayed at the last screen # ready for the user/admin to press the Finish button. # Set to N if you'd like the user to review the suggestions. jump-to-verify-page=Y # # Set to Y if the Back/Previous button should be disabled. This # will prevent the installer from being able to change the # defaults in the configuration wizard. This should be used in # conjunction with the jump-to-verify-page option. disable-back-button=N
Please feel free to contact our Support Team if you have any questions, comments or require further configuration options here.
keywords: silent install, push install, automatic