Automated PaperCut Server Deployment

KB Home   |   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 or MG automatically on multiple independent Servers. This article is not applicable to most installations where PaperCut is installed once on an organisation’s network.

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 setup.exe wizard.
  • 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.

Installer Command-Line Options

The following batch file will automatically start the PaperCut NG installer installing into C:\Applications

do-install.bat

 
    REM Installing PaperCut
    pcng-setup.exe /TASKS="full" /SILENT /DIR="c:\Applications" 
    REM Installation complete.  
    REM Open browser to http://localhost:9191/ to complete configuration.
    pause
  

There are different types of installaions 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.):

/TYPE=full
Install the default option of a PaperCut Application Server.
/TYPE=secondary_print
/TYPE=secondary_web_print
/TYPE=site_server

Some other command line switches include:

/VERYSILENT
When a setup is set to very silent the installation progress window is not displayed (this runs entirely in the background). Use this instead of /SILENT.
/NOCANCEL
Prevents the user from cancelling during the installation process, by disabling the Cancel button and ignoring clicks on the close button.
/DIR
Defines the default install location. Leave this off to install into the system’s default, i.e. the Program Files folder for Windows.
/MERGETASKS=“!desktopicon”
Stops a Shortcut from being added to Desktop during the installation.

License Install

If the supplied digitally signed license file is renamed to application.license and placed in the same directory as the pcng-setup.exe or 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.

Default Configuration

After PaperCut NG/MF is installed for the first time and a web browser is openned, 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 setup-defaults.properties

Windows:

Place the setup-defaults.properties file in in the same directory as the pcng-setup.exe or pcmf-setup.exe installer.

Linux:

  1. Run the Linux installer as normal, but answer no to “Would you like to perform these tasks now”
  2. After the installer is finished copy the file setup-defaults.properties to the application directory [app dir]/server/data/conf/setup-defaults.properties
  3. As the root user run the script /usr/local/papercut/MUST-RUN-AS-ROOT to complete the installation.

Use the following file format to define the defaults:

setup-defaults.properties

  

   # 
   # 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.


Categories: Implementation, Deployment


keywords: silent install, push install, automatic

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on February 26, 2019, at 05:03 PM
Printable View   |   Article History   |   Edit Article