Installation on Novell OES Linux (iPrint)
The following section assumes knowledge of general Novell OES Linux system management including using the command-line, creating users, editing configuration files, and understanding file permissions.
Step 1: System requirements and printer setup
Before starting the installation, take a few moments to verify you have the system requirements.
- Is the operating system version supported and are patches up-to-date? (see
PaperCut MF System Requirements).
- PaperCut NG/MF is designed to integrate with iPrintiPrint is a technology developed by Novell that allows users to install printer-drivers from a web browser and to submit print jobs over the Internet or a local network through the standard Internet Printing Protocol (IPP). Common desktop operating systems such as Windows, Linux, and Mac support iPrint. on Novell OES Linux. If your printers are currently hosted on iPrint on a Netware server or even under legacy NDPS, migrate your queues over to an OES Linux based server. Ensure your printing is correctly working under iPrint on OES Linux before continuing to the next step.
iPrint and the print queues must be configured and confirmed to work before progressing to step 2.
Step 2: Create the host user account and firewall settings
PaperCut NG/MF runs and installs under a non-privileged user account called "papercut". The papercut user's home directory location is the application install location. /home/papercut is recommended, however, Administrators might choose an alternate install location depending on personal preference. Alternatives include:
The host user account is not an eDirectory account but a local system account. One way to create the "papercut" account on OES Linux is:
Open YaST Control Panel; then under Security and Users select User and Group Administration.
Select Users; then click Add to create a new user. The New Local User screen is displayed.
On the User Data tab, enter a username of papercut and assign a password.
On the Details tab, select Empty Home with permissions 755 and change the Home Directory path to define an alternate install location.
Click OK. The User and Group Administration screen is displayed.
Select Groups; then click Add. The New Local Group screen is displayed.
Type the group's name as papercut.
In the Group Members list, select the new user you just added.
Click OK; then click Accept to create the account.
This quick start guide assumes the install location is /home/papercut. If an alternate home location is defined, some of the paths listed in subsequent sections will require modification.
A default OES Linux installation imposes strict resource usage limits on user accounts (ulimit). The papercut account is a special account used for hosting an application so needs to be granted satisfactory resource limits such as the ability to open many files. On systemd Linux distributions, this limit is automatically configured so you do not need to do anything. For other distributions, the methods of setting user-level ulimit levels vary, however, the common solution is to add the following line to /etc/security/limits.conf:
papercut - nofile 65535
Novell OES Linux has a strict default firewall policy. PaperCut NG/MF uses TCP Ports 9191 (for HTTP), 9192 (for HTTPS/ SSLSecure Sockets Layer (SSL) is the standard security technology for establishing an encrypted link between a web server and a browser. This link ensures that all data passed between the web server and browsers remain private and integral. The protocol uses a third party, a Certificate Authority (CA), to identify one end or both end of the transactions. To be able to create an SSL connection a web server requires an SSL certificate. When you choose to activate SSL on your web server you will be prompted to complete a number of questions about the identity of your website and your company. Your web server then creates two cryptographic keys - a Private Key and a Public Key.), 9193 (for Binary) and 9195 (for HTTPS/ SSL on supported devices) and these ports must be open. To open these ports:
Open YaST Control Panel; then select Firewall under Security and Users.
Select Allowed Services, then click Advanced.
Add ports 9191 and 9192 to the TCP Ports list (separated by spaces).
Click OK, Next, then Accept to apply the changes.
Step 3: Download and install PaperCut NG/MF
PaperCut NG/MF is supplied as a self-extracting and self-installing archive. The installation is performed under the rights of the newly created papercut account and temporary root access is required. Make sure the root password is handy. (Administrators who are after a detailed explanation of the install process should also consult the background information in PaperCut NG/MF on Linux).
Log on as the newly created papercut user and download and execute the installer from the command prompt. Here is an example using wget to fetch the installer:
shell> su - papercut
shell> wget [download url from PaperCut Software website]
shell> sh ./pcmf-setup-novell-oes-linux.sh
Follow the installation instructions and enter the root password when requested.
Ensure you login as the user papercut so that the user's environment is sourced and the home directory (install location) is correctly defined.
The installation process takes between two and five minutes depending on the speed of the system. A system restart is not required but administrators are advised to perform installation on live production systems during periods of low activity - for example, not during backup operations or other administration activities.
Step 4: Run the Configuration Wizard
C:\Users\%username%\AppData\Local\Temp\Setup log %install date%
After installation, you are prompted to open a web browser at :
The configuration stages are explained below:
- Complete the following fields:
Password—enter the master password for the main in-built admin account. This password is independent of the operating system or domain passwords. The password must be at least six characters.Tip:
Keep this password secure. If you forget your password, you can reset it. For more information, see Resetting the Admin Password.
- Verify password—re-enter the password.
- Location—select the system's physical location and language.
The Organization type screen is displayed.
This selection determines which system defaults are used.
- Select your organization type.
Default cost for printing
The Default costs for printing screen is displayed.
For an education implementation, where users are charged for their printing, leave these values as zero during the implementation stage, otherwise, students will not be able to print as they cannot yet add credit to their account.
If required, you can change this setting after installation.
- Complete the following fields:
- Color (cost per page)—enter the default cost per page for color printing on all printers.
- Grayscale (cost per page)—enter the default cost per page for grayscale printing on all printers.
Initial user credit (Education organization type only)
If you selected Education as the organization type, the Initial user credit screen is displayed.
If you selected Small/Medium Enterprise (SME) or Corporate) or Professional (Client Billing) as the organization type, go to step 5.
Complete the following fields:
- Initial user credit—enter the amount of credit each/quota each user will receive when the system is first enabled. You can change these settings after setup.
Deny access when users run out of credit/quota—select this check box to prevent users from printing when they run out of credit/quota.Tip:
If you are evaluating PaperCut NG/MF it might be appropriate not to disable printing when a users funds run out. This way you can be assured that user printing is not disrupted during the evaluation.
- Click Next.
To speed up the installation, you can click Skip this step and synchronize the users/groups later.
PaperCut NG/MF extracts user information out of the System or Domain. This is usually LDAPThe Lightweight Directory Access Protocol (LDAP) is a directory service protocol that runs on a layer above the TCP/IP stack. It provides a mechanism used to connect to, search, and modify Internet directories. The LDAP directory service is based on a client-server model. or Google Cloud Directory. The options presented here vary depending on the Operating System and its environment. During evaluation, most sites import all users from the system/domain into PaperCut NG/MF. An option also exists to import a subset of users from a given group. This option is useful when only a subset of users will use the printers.
PaperCut NG/MF has native support for eDirectory LDAP schemas. This is the default user import option for most sites.
PaperCut NG/MF does its best to auto-discover LDAP settings, but some knowledge of eDirectory and/or LDAP is required. More information on LDAP is available in Synchronize user and group details with LDAP.
Google Cloud Directory
You also have the option to use Google Cloud Directory as the sync source. To set up Google Cloud Directory as the sync source, follow these instructions.
Remember, this functionality is available for organizations using G Suite Education, G Suite Enterprise for Education, G Suite Enterprise, and Cloud Identity Premium.
Before you start, make sure you can log in to Google as a Super Admin.
- Log in to admin.google.com using your Super Admin user login details. The Google Admin console is displayed.
- Click the Apps tile. The Apps screen is displayed.
- Click the LDAP tile. The LDAP screen is displayed.
- Click ADD CLIENT.
- Type the name and a description of the LDAP you’ll be using to access PaperCut NG/MF; then click CONTINUE. The Access permissions screen is displayed.
- In the Verify user credentials section, select Entire domain <domain name>.
- In the Read user information section, select Entire domain <domain name>.
- In the Read group information section, click the switch to set it to On; then click ADD LDAP CLIENT. Google displays a confirmation message and information about downloading the certificate.
- On the same screen, click Download certificate; then save the downloaded certificate (which is a PDF file) in a secure location.
- Click CONTINUE TO CLIENT DETAILS. The Settings for <LDAP client name> screen is displayed.
- Click anywhere in the Service Status box. The Service Status screen is displayed.
- Select On for everyone. The service status is updated for everyone.
- Click SAVE.
You can find more information about configuring access permissions from Google.
The service status, displayed at the top right of the screen, is initially set to OFF.
Depending on the size of your organization, it can take up to 24 hours for Google Cloud Directory changes to apply.
User Client options (Professional (Client Billing) organization type only)
If you selected Professional (Client Billing), as the organization type, the User client options screen is displayed.
If you selected Education or Small/Medium Enterprise (SME) or Corporate, go to step 7.
The User client allows users to allocate print jobs to client (shared) accounts. The process works by:
Pausing all jobs that enter the print queues.
Displaying a popup on the user's workstation asking them to allocate the print job to an account. This is done by selecting the account from a list.
After the user has responded to the popup, the job is released to the printer.
For more information about the account selection process and shared accounts, see Shared accounts.
The account selection popup option is enabled at the user level. Once the option is enabled, the user must run the client software. If the client software is not running, the popup cannot display, and the job remains paused in the print queueA print queue displays information about documents that are waiting to be printed, such as the printing status, document owner, and number of pages to print. You can use the print queue to view, pause, resume, restart, and cancel print jobs.. This option is considered high impact. You are presented with two strategies that allow you to choose the implementation approach that best suits your needs.
Select the account implementation strategy:
Minimal impact (Initial single user testing)—the account popup is enabled only for a single user for testing purposes. You need to nominate the testing account; this can be an existing system/domain account used for testing purposes or your own user account. The username should be in the format used to log in to the domain/system (usually the short form).
The minimal impact strategy allows you to test the popup with the nominated test system/domain user account, after which you can enable thepopup for other users as appropriate.
Immediate implementation (Enable for all users)—enables the account selection popup for all users. Once the client has been deployed, the system is operational. If this option is selected, install the client software on user desktops immediately to prevent disruption of user printing services.
If in doubt, select the minimal impact strategy. This ensures the impact is isolated to only the nominated test account.
Confirm setup options
The Confirm setup options screen is displayed.
- Check the settings you have entered. If you want to change anything, you can return to any of the configuration screens to alter the options.
The Initial user import screen is displayed.
After completing the configuration wizard you are presented with a user synchronization status screen, showing the progress and results of the setup.
- Click Login to access the Admin web interface and begin familiarizing yourself with the options and features available.
Step 5: Configure the iPrint printer
PaperCut NG/MF works by directly integrating with the Novell iPrint Print Manager. iPrint must, however, be configured to use PaperCut NG/MF as an accounting control source. In the current release, this configuration is done manually at the individual print queue level:
Log in to iManager, expand iPrint; then select Manage Printer Manager.
Select the Printer Manager associated with one of your print queues.
Click the Manage health monitor link. A list of all your printers is displayed.
Select a Printer Agent from the list.
Click Configuration Options.
Enter papercut under the Accounting Autoload Command. Take care to write this all in lower case with no spaces.
Click Back, then Back and repeat steps 4 through 7 for all printers you want monitored/controlled by PaperCut NG/MF
In line with best practice, backup the new printer configuration (padbtxt.xml) as follows:
In iManager open up the active Print Manager.
Select Manager health monitor > Advanced iPrint Manager Information > iPrint Manager Internal
Click Backup Database.
Finally restart the Printer Manager in iManager by clicking Shutdown then Startup. After this, all jobs on the queues are tracked.
Step 6 - Sharing User Client software
The PaperCut NG/MF client software is located in the local directory:
/home/papercut/clientThis software needs to be shared over the network so workstations can access/install the client application. Novell iManager provides a number of file sharing options. One simple solution is to add a read-only NCP or SambaSamba is a Windows interoperability suite of programs for Linux and Unix. It is used to integrate Linux/Unix servers and desktops into Active Directory environments. It can function as both a domain controller or as a regular domain member. share called PCClient pointing to /home/papercut/client. Established networks will benefit from ensuring the client files are available in their Distributed Files Services. The deployment of the client software (e.g. zero-install deployment) is covered in User Client.
Step 6: Deployment for a Professional (Client Billing) installation
This step is a requirement for a Professional (Client Billing) installation.
Now that the system is tested and working, it is time to deploy the client software and enable the account popup for their use. It is important to deploy the client software before enabling the popup, otherwise users' printing is stopped/paused.
Deploy the client software
The User Client can be run directly from a network share (which is automatically configured on Windows). There is also the option to install the software locally on each workstation, however, this is not usually recommended because it makes the process of updating the client software more complicated.
For more information about client deployment options, see User Client. Follow those instructions to deploy the client software, and then enable the popup as described below.
Enable the advanced client popup
Once the client software is deployed on user workstations, you can set the Account Selection. In a Professional (Client Billing) configuration, users who print jobs for clients are often given the Advanced account selection popup, however, other Account Selection options might be better suited for some users based on their job function. You can enable the popup on one user at a time or update for all users in bulk. Use the User Details page to enable the popup for a single user. To enable the popup for all users in bulk:
Click the Users tab.
The User List page is displayed.
In the Actions menu, click Bulk user actions.
The Bulk User Operations page is displayed.
In Perform operations on users, select the target group. To enable for all users select the [All Users] group.
In the Change setting area, select the Change account selection setting check box.
Select Show the advanced account selection popupThe advanced account selection popup is a mode for the desktop client that caters for professional businesses with a large number of accounts. It provides powerful features that allow users to quickly assign printing to accounts selected from a large list of clients or projects, such as keyword search, recently selected accounts, and preferred accounts. You can also apply cost adjustments to a print job at time of print. option from the list.
If you do not want to allow users to charge printing to their personal account, clear the Allow user to charge to their personal account check box.
A confirmation window is displayed.
Once completed, the account popup is enabled for the selected users.
When the popup is enabled for all users, perform some testing from users' desktops. To test, log in to the user workstation, perform a print, and check that the account popup is displayed and the job is logged as expected.
Step 7: Testing
Following a fresh installation, it is highly recommended to test core features of the system. For further details, see Testing the installation.
Take some time to explore the features of PaperCut NG/MF before continuing reading at Implementation by example or Tour. Business users might be interested in trying the popup client software as covered in Client software. If desired, the client software should also be deployed to other workstations. This procedure is detailed in User Client.