Changes between Version 7 and Version 8 of Software/Configuration/Files


Ignore:
Timestamp:
03/24/14 19:45:07 (6 years ago)
Author:
smith@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Software/Configuration/Files

    v7 v8  
    33This page contains a listing of the main files installed by each Raptor package, along with a brief description of the purpose of that file. 
    44 
     5Note that the files in **bold** are considered system files and may be overwritten on upgrade. Those not in bold are considered user configuration files and will not be overwritten on upgrade (unless otherwise noted in the release notes for a particular version)  
     6 
    57= Raptor ICA = 
    68 
    79Within the Raptor ICA's home directory ({{{/opt/raptor/ica}}} on linux, {{{C:\Program Files\Raptor\ICA}}} on Windows) are the following files: 
    8 * {{{raptor-ica.jar}}} - The main Raptor ICA classfile 
    9 * {{{conf/}}} - Contains all configuration files for the Raptor ICA 
    10  * {{{conf/event-parse-formats-custom.xml}}} - custom configurations can be added here, for parsing arbitrary log files. 
    11  * {{{conf/event-parse-formats-system.xml}}} - Configures which log files the ICA is monitoring, and how to parse them. 
    12  * {{{conf/event-release.xml}}} - Configures the event release policies for the ICA. 
    13  * {{{conf/ica-core.xml}}} - The core ICA springbean configuration file. DO NOT EDIT! 
    14  * {{{conf/logging.xml}}} - Configures logging for the ICA. Change level within to DEBUG to generate more detailed logging. 
    15  * {{{conf/metadata.xml}}} - Configures the ICA instance's information such as name. Used in the UI and stored in the database. 
    16  * {{{conf/server.properties}}} - Configures Jetty - which port the ICA's webserver should run on! 
    17 * {{{lib/}}} - Contains all libraries used by the Raptor ICA 
    18  * {{{lib/*.jar}}} - Many java library files 
    19 * {{{keys/}}} - Contains the Raptor ICA's keystore and truststore 
    20  * {{{keys/raptor-ica.jks}}} - Contains the Raptor ICA's public and private keys used for secure communication. 
    21  * {{{keys/raptor-ica-public.crt}}} - The PEM encoded version of the ICA's public key extracted from {{{raptor-ica.jks}}} 
    22  * {{{keys/authorised-keys.jks}}} - Contains the public keys of every MUA the ICA is authorised to communicate with 
    23 * {{{logs/}}} - Contains the Raptor ICA's log files 
    24  * {{{logs/ica-process.log}}} - The main log file for the ICA. 
     10* **{{{raptor-ica.jar}}}** - ''The main Raptor ICA classfile.'' 
     11* {{{conf/}}} - ''Contains all configuration files for the Raptor ICA.'' 
     12 * {{{conf/event-parse-formats-custom.xml}}} - ''custom configurations can be added here, for parsing arbitrary log files.'' 
     13 * **{{{conf/event-parse-formats-system.xml}}}** - ''configures how the ICA parses log files.'' 
     14 * {{{conf/event-parse.xml}}} - ''configures which log files the ICA is monitoring.'' 
     15 * {{{conf/event-release.xml}}} - ''configures the event release policies for the ICA.'' 
     16 * **{{{conf/ica-core.xml}}}** - ''the core ICA springbean configuration file.'' 
     17 * {{{conf/logging.xml}}} - ''configures logging for the ICA. Change level within to DEBUG to generate more detailed logging.'' 
     18 * {{{conf/metadata.xml}}} - ''configures the ICA instance's information such as name. Used in the UI and stored in the database.'' 
     19 * {{{conf/server.properties}}} - ''configures Jetty - which port the ICA's webserver should run on!'' 
     20* {{{lib/}}} - ''contains all libraries used by the Raptor ICA.'' 
     21 * **{{{lib/*.jar}}}** - ''many java library files.'' 
     22* {{{keys/}}} - ''contains the Raptor ICA's keystore and truststore.'' 
     23 * {{{keys/raptor-ica.jks}}} - ''contains the Raptor ICA's public and private keys used for secure communication.'' 
     24 * {{{keys/raptor-ica-public.crt}}} - ''the PEM encoded version of the ICA's public key extracted from {{{raptor-ica.jks}}}'' 
     25 * {{{keys/authorised-keys.jks}}} - ''contains the public keys of every MUA the ICA is authorised to communicate with.'' 
     26* {{{logs/}}} - ''contains the Raptor ICA's log files'' 
     27 * {{{logs/ica-process.log}}} - ''the main log file for the ICA.'' 
    2528 
    2629 
     
    2932Within the Raptor MUA's home directory ({{{/opt/raptor/mua}}} on linux, {{{C:\Program Files\Raptor\MUA}}} on Windows) are the following files: 
    3033 
    31 * . 
     34* {{{batchimport}}} - ''contains various directories where you can drop old log files for batch parsing.'' 
     35* {{{conf/}}} - ''Contains all configuration files for the Raptor MUA.'' 
     36 * {{{conf/attribute-association.xml}}} - ''configures how the MUA pulls in extra information from a data source (e.g. dept/affiliation) to enrich the stats data'' 
     37 * {{{conf/batch-event-parse-formats-custom.xml}}} - ''custom configurations can be added here, for parsing arbitrary log files.'' 
     38 * **{{{conf/batch-event-parse-formats-system.xml}}}** - ''configures how the MUA parses log files.'' 
     39 * {{{conf/batch-event-parse.xml}}} - ''configures which batchimport directories the MUA is monitoring.'' 
     40 * {{{conf/database.xml}}} - ''configures how the MUA connects to a database to store events.'' 
     41 * {{{conf/event-release.xml}}} - ''configures the event release policies for the MUA.'' 
     42 * {{{conf/logging.xml}}} - ''configures logging for the MUA. Change level within to DEBUG to generate more detailed logging.'' 
     43 * {{{conf/metadata.xml}}} - ''configures the MUA instance's information such as name. Used in the UI and stored in the database.'' 
     44 * **{{{conf/mua-core.xml}}}** - ''the core MUA springbean configuration file.'' 
     45 * . 
     46 * {{{conf/server.properties}}} - ''configures Jetty - which port the ICA's webserver should run on!'' 
     47* {{{data/}}} - ''contains the HSQLDB used by the Raptor MUA.'' 
     48* {{{lib/}}} - ''contains all libraries used by the Raptor MUA.'' 
     49 * **{{{lib/*.jar}}}** - ''many java library files.'' 
     50* {{{keys/}}} - ''contains the Raptor ICA's keystore and truststore.'' 
     51 * {{{keys/raptor-mua.jks}}} - ''contains the Raptor MUA's public and private keys used for secure communication.'' 
     52 * {{{keys/raptor-mua-public.crt}}} - ''the PEM encoded version of the MUA's public key extracted from {{{raptor-mua.jks}}}'' 
     53 * {{{keys/authorised-keys.jks}}} - ''contains the public keys of every MUA the MUA is authorised to communicate with.'' 
     54* {{{logs/}}} - ''contains the Raptor MUA's log files'' 
     55 * {{{logs/ica-process.log}}} - ''the main log file for the MUA.'' 
    3256 
    3357= Raptor Web =