Appendix F. File Locations
Prev		Next

Appendix F. File Locations

The table below summarizes the SavaPage file locations.

Important

When overriding defaults, make sure the location for SavaPage temporary files resides on the same disk partition as the locations used to store data on runtime. See:

Path Description

Path	Description
/opt/savapage/	Install directory.
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.
app/	Chapter 11, User Client.
config/	Section 11.2, “User Client Deployment” `client.properties`
jmx/	Section 4.11.13.4, “JMX Agent”.
linux/	.desktop templates.
providers/	Section 1.3.1.6, “Information Provider”
cups/	Section 13.5.4.1, “CUPS Notifier”.
nfc/	Section B.3, “Network Card Reader Service”.
server/	Home of server application. Passed as system property `server.home` at the start of the `java` server application.
bin/	Section C.1, “Server Commands”. Section C.4, “Database Commands”.
custom/	Section 22.3, “JVM Tuning” `app-server.conf` Section C.6, “SSL Key Generation” `my-ssl-keystore.jks` Section 20.1, “Custom Web App” `web.properties`
cups/	Appendix K, PPD Extensions
i18n/	Section L.3, “IPP Localization”
template/	Section 20.2, “Email Templates”
i18n/	Section 20.1.1.4, “Custom i18n”
data/	Section 17.2.1.3, “Internal Admin Password” `admin.properties` Section 17.5, “SSL Certificate and Password” `default-ssl-keystore.` Section 17.7, “Encrypted Secrets” `encryption.properties` Section J.1.6, “Google Cloud Directory” `google-ldap-client-cert.` Section 4.11.13.4, “JMX Agent” `jmxremote.*` Log4j configuration `log4j.properties` Section 4.14.3, “Community” `savapage.membercard` Section 13.5, “Advanced Configuration” `server.properties`
.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 `server.properties` file. See Section 13.5.10, “Alternative File Locations”.
backups/	Section 4.11.12, “Backups”.
conf/	Section 4.11.1.5, “Internal Groups” `internal-groups.txt` : Section 15.1.18, “User Alias” `username-aliases.txt` :
doc-archive/ out/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID]	Print Archive 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 Section 13.5.10, “Alternative File Locations”.
doc-journal/ out/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID]	Print Journal Analogous to `doc-archive`.
doc-journal/ in/print/ [CCYY]/ [MM]/ [DD]/ [HH]/ [UUID]	Queue Journal Analogous to `doc-jounal/out`.
email-outbox/	Outgoing email queue.
internal/
Derby/	Section 1.2.1.4, “Database”.
letterheads/	Section 3.6, “Letterheads” Also see Section 13.5.10, “Alternative File Locations”.
safepages/	Section 3.3, “SafePages”. Also see Section 13.5.10, “Alternative File Locations” and Section 13.5.7, “User Home Clean”.
print-jobtickets/	Chapter 5, Job Tickets Web App.
docs/	Accessible via URL: Appendix E, URL Cheat Sheet
examples/	Section 14.1, “IPP Everywhere and AirPrint”
data/	Configuration file templates that may contain additional features compared to their `/opt/savapage/data` counterparts.
papercut/	Section N.4, “PaperCut User Sync and Auth Interface”
ext/	Appendix M, SavaPage Plug-ins `savapage-ext-*.properties`
lib/	Extension JAR files.
logs/	Extension log files.
lib/	Main WAR and JAR files including supporting SQL scripts.
logs/	Main log files.

/opt/savapage/

Install directory.

  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.

    app/

Chapter 11, User Client.

      config/

Section 11.2, “User Client Deployment”

client.properties

    jmx/

Section 4.11.13.4, “JMX Agent”.

    linux/

.desktop templates.

  providers/

Section 1.3.1.6, “Information Provider”

    cups/

Section 13.5.4.1, “CUPS Notifier”.

    nfc/

Section B.3, “Network Card Reader Service”.

  server/

Home of server application. Passed as system property server.home at the start of the java server application.

    bin/

    custom/

Section 22.3, “JVM Tuning”

app-server.conf

Section C.6, “SSL Key Generation”

my-ssl-keystore.jks

Section 20.1, “Custom Web App”

web.properties

      cups/

Appendix K, PPD Extensions

        i18n/

Section L.3, “IPP Localization”

      template/

Section 20.2, “Email Templates”

      i18n/

Section 20.1.1.4, “Custom i18n”

    data/

Section 17.2.1.3, “Internal Admin Password”

admin.properties

Section 17.5, “SSL Certificate and Password”

default-ssl-keystore.*

Section 17.7, “Encrypted Secrets”

encryption.properties

Section J.1.6, “Google Cloud Directory”

google-ldap-client-cert.*

Section 4.11.13.4, “JMX Agent”

jmxremote.*

Log4j configuration

log4j.properties

Section 4.14.3, “Community”

savapage.membercard

Section 13.5, “Advanced Configuration”

server.properties

      .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 server.properties file. See Section 13.5.10, “Alternative File Locations”.

      backups/

Section 4.11.12, “Backups”.

      conf/

Section 4.11.1.5, “Internal Groups”

internal-groups.txt :

Section 15.1.18, “User Alias”

username-aliases.txt :

      doc-archive/
        out/print/
          [CCYY]/
            [MM]/
              [DD]/
                [HH]/
                  [UUID]

Print Archive

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 Section 13.5.10, “Alternative File Locations”.

      doc-journal/
        out/print/
          [CCYY]/
            [MM]/
              [DD]/
                [HH]/
                  [UUID]

Print Journal

Analogous to doc-archive.

      doc-journal/
        in/print/
          [CCYY]/
            [MM]/
              [DD]/
                [HH]/
                  [UUID]

Queue Journal

Analogous to doc-jounal/out.

      email-outbox/

Outgoing email queue.

      internal/

        Derby/

Section 1.2.1.4, “Database”.

        letterheads/

Section 3.6, “Letterheads”

Also see Section 13.5.10, “Alternative File Locations”.

        safepages/

Section 3.3, “SafePages”.

Also see Section 13.5.10, “Alternative File Locations” and Section 13.5.7, “User Home Clean”.

      print-jobtickets/

Chapter 5, Job Tickets Web App.

    docs/

Accessible via URL: Appendix E, URL Cheat Sheet

    examples/

Section 14.1, “IPP Everywhere and AirPrint”

      data/

Configuration file templates that may contain additional features compared to their /opt/savapage/data counterparts.

      papercut/

Section N.4, “PaperCut User Sync and Auth Interface”

    ext/

Appendix M, SavaPage Plug-ins

savapage-ext-*.properties

      lib/

Extension JAR files.

      logs/

Extension log files.

    lib/

Main WAR and JAR files including supporting SQL scripts.

    logs/

Main log files.

Table F.1. SavaPage File Locations

Prev		Next
Appendix E. URL Cheat Sheet	Home	Appendix G. Printable File Types