{"id":22462,"date":"2024-02-15T14:48:40","date_gmt":"2024-02-15T22:48:40","guid":{"rendered":"https:\/\/docs.extraview.com\/v22\/book\/installation-configuration-0\/"},"modified":"2024-02-15T16:32:15","modified_gmt":"2024-02-16T00:32:15","slug":"installation-configuration-0","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/","title":{"rendered":"Installation & Configuration"},"content":{"rendered":"

Please consult the Installation & Upgrade Guide<\/a> for details on how to install the CLI.<\/p>\n

\n\tConfiguring for Linux \/ UNIX<\/h3>\n

To configure the CLI, all users must configure their accounts with an environment variable named EVDIR. This should have a value that points to the directory that contains the file named evconfig.txt. For example, the appropriate command may be:<\/p>\n

setenv EVDIR=\/extraview\/api<\/p>\n

\n\tThe evconfig.txt File<\/h3>\n

The file evconfig.txt<\/span> contains information that points to the server components where ExtraView is located as well as other required information. An example of the file is shown below.<\/p>\n

SERVER = myserver.mycompany.com\/evj\/ExtraView
\n\tPOP3_USER = myname
\n\tPOP3_PASSWORD = mypass
\n\tPOP3_SERVER = mail.mycompany.com
\n\tSUBJ_REGEX = ^Subject
\n\tSMTP_SERVER = mail.mycompany.com<\/code><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\t\t<\/tr>\n\n
\n\t\t\t\tSERVER<\/td>\n\n\t\t\t\tThis entry is the URL of the ExtraView API module as installed<\/td>\n<\/tr>\n
\n\t\t\t\tPOP3_USER<\/td>\n\n\t\t\t\tThe user\u2019s email address on the POP3 server<\/td>\n<\/tr>\n
\n\t\t\t\tPOP3_PASSWORD<\/td>\n\n\t\t\t\tThe user\u2019s email password on the POP3 server<\/td>\n<\/tr>\n
\n\t\t\t\tPOP3_SERVER<\/td>\n\n\t\t\t\tThe address of the POP3 server on the network<\/td>\n<\/tr>\n
\n\t\t\t\tSUBJ_REGEX<\/td>\n\n\t\t\t\tRegular expression used to identify the submitted issue and the action to be taken when the mail is processed<\/td>\n<\/tr>\n
\n\t\t\t\tSMTP_CC<\/td>\n\n\t\t\t\tThis address is used when delivery of mail through ExtraView fails. This avoids mail not being delivered to any address and just sitting in a queue<\/td>\n<\/tr>\n
\n\t\t\t\tSMTP_FAIL_MSG_FNAM<\/td>\n\n\t\t\t\tThis is the absolute path of a file that contains a template to be used in the event of a failure of the mail delivery system through ExtraView. If the message is not processed by ExtraView, this file is used as the body of the mail to be sent to the addresses in SMTP_FROM and SMTP_CC. If the body contains a tag __BODY__, then the tag is replaced by the email being processed. If the body contains a tag __REASON_, then the tag is replaced by the error message returned as an error message from ExtraView<\/td>\n<\/tr>\n
\n\t\t\t\tSMTP_FROM<\/td>\n\n\t\t\t\tThis address is used when delivery of mail through ExtraView fails. This avoids mail not being delivered to any address and just sitting in a queue<\/td>\n<\/tr>\n
\n\t\t\t\tSMTP_SERVER<\/td>\n\n\t\t\t\tThe SMTP server for email<\/td>\n<\/tr>\n
\n\t\t\t\t-B true<\/td>\n\n\t\t\t\tThis is an optional entry within the file.  If this is present, the CLI will not attempt to use SAML as an authentication method if this is used for thebrowser interface, but will use ExtraView’s internal authentication mechanism<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tConfiguring for Microsoft Windows<\/h3>\n

This is very similar to the Linux \/ UNIX installation. Please follow the instructions but with these differences:<\/p>\n

    \n
  • \n\t\tThe .evrc file is named evrc.txt and is stored in the current directory<\/li>\n
  • \n\t\tWindows NT and Windows 2000 use AT commands as opposed to cron jobs to run tasks on a timed basis.<\/li>\n<\/ul>\n

    \n\tConfiguring the CLI to work with HTTPS<\/h3>\n

    The CLI supports HTTPS, SSL SMTP and SSL POP3. Configuring the CLI to use these features requires manual configuration.<\/p>\n

    \n\tStep 1<\/h4>\n

    Modify the evconfig.txt configuration file by adding the following lines:<\/p>\n

    HTTPS = on
    \n\tPOP3_SSL = on
    \n\tPOP3_SSL_PORT = 995 # change to your POP3 port number
    \n\tSMTP_SSL = on
    \n\tSMTP_SSL_PORT = 465 # change to your SMTP port number
    \n\tHB_SMTP_SSL=on
    \n\tHB_SMTP_SSL_PORT=465 # change to your HB_SMTP port number<\/code><\/p>\n

    \n\tStep 2<\/h4>\n

    Download and install OpenSSL from http:\/\/www.openssl.org\/. This must be done before the next step in the installation procedure.<\/p>\n

    \n\tStep 3<\/h4>\n

    Download and manually install the following Perl Modules. These cannot be automatically installed by ExtraView\u2019s installation procedures as ExtraView\u2019s installation is machine independent and these modules generate and install machine-specific code during their installation.<\/p>\n

    \tNet_SSLeay.pm<\/b>
    \n\tPerl extension for using OpenSSL
    \n\tVersion: 1.30
    \n\tAuthor: Sampo Kellomaki
    \n\t CPAN: http:\/\/search.cpan.org\/dist\/Net_SSLeay.pm-1.30\/<\/sampo@iki.fi><\/p>\n

    IO-Socket-SSL<\/b>
    \n\tNearly transparent SSL encapsulation for IO::Socket::INET.
    \n\tVersion: 1.08
    \n\tAuthor: Steffen Ullrich & Peter Behroozi & Marko Asplund
    \n\tCPAN: http:\/\/search.cpan.org\/dist\/IO-Socket-SSL-1.08\/<\/sampo@iki.fi><\/p>\n

    Net-SMTP-SSL<\/b>
    \n\tSSL support for Net::SMTP
    \n\tVersion: 1.01
    \n\tAuthor: Casey West
    \n\tCPAN: http:\/\/search.cpan.org\/dist\/Net-SMTP-SSL-1.01\/<\/casey@geeknest.com><\/sampo@iki.fi><\/p>\n

    Crypt-SSLeay<\/b>
    \n\tOpenSSL glue that provides LWP https support
    \n\tVersion: 0.53
    \n\tAuthor: Joshua Chamas
    \n\tCPAN: http:\/\/search.cpan.org\/dist\/Crypt-SSLeay-0.53\/ <\/josh><\/casey@geeknest.com><\/sampo@iki.fi><\/p>\n","protected":false},"excerpt":{"rendered":"

    Please consult the Installation & Upgrade Guide for details on how to install the CLI. Configuring for Linux \/ UNIX To configure the CLI, all users must configure their accounts with an environment variable named EVDIR. This should have a value that points to the directory that contains the file named evconfig.txt. For example, the…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-22462","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nInstallation & Configuration - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Installation & Configuration - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Please consult the Installation & Upgrade Guide for details on how to install the CLI. Configuring for Linux \/ UNIX To configure the CLI, all users must configure their accounts with an environment variable named EVDIR. This should have a value that points to the directory that contains the file named evconfig.txt. For example, the...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2024-02-16T00:32:15+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/\",\"url\":\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/\",\"name\":\"Installation & Configuration - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\"},\"datePublished\":\"2024-02-15T22:48:40+00:00\",\"dateModified\":\"2024-02-16T00:32:15+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v22\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installation & Configuration\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Installation & Configuration - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/","og_locale":"en_US","og_type":"article","og_title":"Installation & Configuration - Product Documentation","og_description":"Please consult the Installation & Upgrade Guide for details on how to install the CLI. Configuring for Linux \/ UNIX To configure the CLI, all users must configure their accounts with an environment variable named EVDIR. This should have a value that points to the directory that contains the file named evconfig.txt. For example, the...","og_url":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/","og_site_name":"Product Documentation","article_modified_time":"2024-02-16T00:32:15+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/","url":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/","name":"Installation & Configuration - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v22\/#website"},"datePublished":"2024-02-15T22:48:40+00:00","dateModified":"2024-02-16T00:32:15+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v22\/installation-configuration-0\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v22\/"},{"@type":"ListItem","position":2,"name":"Installation & Configuration"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v22\/#website","url":"https:\/\/docs.extraview.com\/v22\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v22\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v22\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v22\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v22\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22462","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/comments?post=22462"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22462\/revisions"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/media?parent=22462"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}