.. /* * This file is part of the SavaPage project . * Copyright (c) 2026 Datraverse B.V. * Author: Rijk Ravestein. * * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. * SPDX-License-Identifier: CC-BY-SA-4.0 * * For more information, please contact Datraverse B.V. at this * address: info@datraverse.com */ .. _app-file-locations: .. figure:: ../images/manual/savapage-logo-no-text-100px.png :width: 75px File Locations ============== The table below summarizes the |PRODUCT_NAME| file locations. .. important:: When overriding defaults, make sure the location for |PRODUCT_NAME| temporary files resides on the same |image1| disk partition as the locations used to store data on runtime. See: - :ref:`Alternative File Locations `. - :ref:`JVM Temporary Files `. .. list-table:: |PRODUCT_NAME| File Locations :width: 100% :widths: 35 65 :header-rows: 1 * - Path - Description * - .. code-block:: text $ /opt/savapage/ - Install directory. * - .. code-block:: text $ client/ - Home of client applications. Sibling of home of server application, or passed as system property ``client.home`` at the start of a ``java`` client application. * - .. code-block:: text $ app/ - :ref:`User Client `. * - .. code-block:: text $ config/ - :ref:`User Client Deployment `. - ``client.properties`` * - .. code-block:: text $ jmx/ - :ref:`JMX Agent `. * - .. code-block:: text $ linux/ - ``.desktop`` templates. * - .. code-block:: text $ providers/ - :ref:`Information Provider `. * - .. code-block:: text $ cups/ - :ref:`CUPS Notifier `. * - .. code-block:: text $ nfc/ - :ref:`Network Card Reader Service `. * - .. code-block:: text $ server/ - Home of server application. Passed as system property ``server.home`` at the start of the ``java`` server application. * - .. code-block:: text $ bin/ - - :ref:`Server Commands ` - :ref:`Database Commands ` * - .. code-block:: text $ custom/ - :ref:`JVM Tuning ` - ``app-server.conf`` :ref:`SSL Key Generation ` - ``my-ssl-keystore.jks`` :ref:`Custom Web App ` - ``web.properties`` * - .. code-block:: text $ cups/ - :ref:`PPD Extensions ` * - .. code-block:: text $ i18n/ - :ref:`IPP Localization ` * - .. code-block:: text $ html/ - HTML injectable files. * - .. code-block:: text $ i18n/ - - :ref:`Custom i18n ` - :ref:`IPP Localization ` * - .. code-block:: text $ rawprint/ - :ref:`Raw Print ` files. * - .. code-block:: text $ ppd/ - :ref:`Raw Print PPD files `. * - .. code-block:: text $ transforms/ - :ref:`Raw Print PDL Transform files `. * - .. code-block:: text $ template/ - :ref:`Email Templates `. * - .. code-block:: text $ web/ - :ref:`Web App Look-and-feel `. * - .. code-block:: text $ themes/ - :ref:`Web App Theming `. * - .. code-block:: text $ data/ - :ref:`Internal Admin Password ` - ``admin.properties`` :ref:`SSL Certificate and Password ` - ``default-ssl-keystore.*`` :ref:`Encrypted Secrets ` - ``encryption.properties`` :ref:`Google Cloud Directory ` - ``google-ldap-client-cert.*`` :ref:`JMX Agent ` - ``jmxremote.*`` Log4j configuration - :ref:`log4j.properties ` :ref:`Community ` - ``savapage.membercard`` :ref:`Advanced Configuration ` - :ref:`server.properties ` * - .. code-block:: text $ .tmp/ - Default location for temporary files, created when the application starts and removed when stopped. Location can be changed with the ``app.dir.tmp`` property in the :ref:`server.properties ` file. See :ref:`Alternative File Locations `. * - .. code-block:: text $ backups/ - :ref:`Backups `. * - .. code-block:: text $ conf/ - :ref:`Internal Groups ` - ``internal-groups.txt`` :ref:`User Alias ` - ``username-aliases.txt`` * - .. code-block:: text $ doc-archive/ out/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID] - |image1| :ref:`Print Archive ` |br| |br| - Printed PDF and Job Options (in JSON format) are stored in a unique identifying file path of year, month, day, hour and UUID of the print job. - Also see :ref:`Alternative File Locations `. * - .. code-block:: text $ doc-journal/ out/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID] - |image1| :ref:`Print Journal ` |br| |br| Analogous to ``doc-archive``. * - .. code-block:: text $ in/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID] - |image1| :ref:`Queue Journal ` |br| |br| Analogous to ``doc-jounal/out``. * - .. code-block:: text $ email-outbox/ - |image1| Outgoing email queue. * - .. code-block:: text $ internal/ - * - .. code-block:: text $ Derby/ - :ref:`Database `. * - .. code-block:: text $ letterheads/ - |image1| :ref:`Letterheads `. |br| |br| Also see :ref:`Alternative File Locations `. * - .. code-block:: text $ safepages/ .. _app-file-locations-safepages: - |image1| :ref:`SafePages `. |br| |br| Also see :ref:`Alternative File Locations ` and :ref:`User Home Clean `. * - .. code-block:: text $ print-jobtickets/ - |image1| :ref:`Job Tickets Web App `. * - .. code-block:: text $ docs/ - Accessible via URL: :ref:`URL Cheat Sheet ` * - .. code-block:: text $ examples/ - :ref:`IPP Everywhere and AirPrint ` * - .. code-block:: text $ data/ - Configuration file templates that may contain additional features compared to their ``/opt/savapage/data`` counterparts. * - .. code-block:: text $ papercut/ - :ref:`SavaPage as Sync Source in PaperCut `. * - .. code-block:: text $ ext/ - :ref:`SavaPage Plug-ins ` - ``savapage-ext-*.properties`` * - .. code-block:: text $ lib/ - Extension JAR files. * - .. code-block:: text $ logs/ - Extension log files. * - .. code-block:: text $ lib/ - Main WAR and JAR files including supporting SQL scripts. * - .. code-block:: text $ logs/ - Main log files. .. |image1| image:: ../images/manual/famfamfam-silk_drive-16x11.png :width: 16px