Global Configuration Files - Revision history

Llawson: /* Location */

2018-11-27T22:38:23Z

Location

← Older revision		Revision as of 22:38, 27 November 2018
Line 10:		Line 10:
	'''Project''': <HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>/config		'''Project''': <HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>/config

	If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.		If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.


	= Global File Structure =		= Global File Structure =

Llawson at 22:37, 27 November 2018

2018-11-27T22:37:59Z

← Older revision		Revision as of 22:37, 27 November 2018
Line 1:		Line 1:
	~~Some~~ configuration files can be at the global, group or project level.		=Location=
			Global Configuration Files are copied over to the ''L10nStreamlining/config'' folder when LRM is installed for the first time. The original configuration files are located in the ''../lingoport/lrm-server-xx/deploy/templates/dir_structure/glboal'' folder. These files can be moved to the group or project levels if more granularity is needed.

			Configuration files can be at the global, group or project level.

	'''Global''': <HOME>/Lingoport_Data/L10nStreamlining/config		'''Global''': <HOME>/Lingoport_Data/L10nStreamlining/config
Line 9:		Line 12:
	If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.		If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.

	~~=Description=~~
	Global Configuration Files are copied over to the ''L10nStreamlining/config'' folder when LRM is installed for the first time. The original configuration files are located in the ''../lingoport/lrm-server-xx/deploy/templates/dir_structure/glboal'' folder. These files can be moved to the group or project levels if more granularity is needed.

	= Global File Structure =		= Global File Structure =

	The global configuration files are located in '''<code>config</code>''' directory under the L10n Streamlining directory (typically '''<HOME>/Lingoport_Data/L10nStreamlining''')		The global configuration files are located in '''<code>config</code>''' directory under the L10n Streamlining directory (typically '''<HOME>/Lingoport_Data/L10nStreamlining''')

Llawson: /* Global File Structure */

2018-11-27T22:23:17Z

Global File Structure

← Older revision		Revision as of 22:23, 27 November 2018
Line 8:		Line 8:

	If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.		If there are duplicate files, the project level takes precedence, followed by the group level, and finally the global level.

			=Description=
			Global Configuration Files are copied over to the ''L10nStreamlining/config'' folder when LRM is installed for the first time. The original configuration files are located in the ''../lingoport/lrm-server-xx/deploy/templates/dir_structure/glboal'' folder. These files can be moved to the group or project levels if more granularity is needed.

	= Global File Structure =		= Global File Structure =

Llawson: /* config_email_global.xml */

2017-09-08T21:11:52Z

config_email_global.xml

← Older revision		Revision as of 21:11, 8 September 2017
Line 85:		Line 85:

	See [[Sending_Emails \| Sending Emails]] for more information.		See [[Sending_Emails \| Sending Emails]] for more information.

	~~There are 3 types of information contained in the ''config_email_global.xml'' file.~~
	* email configuration
	* interval between the sending of status emails
	* flag indicating whether to send out the 'No Files to Prep' email

	~~=== Email Credentials Configuration ===~~
	~~The email configuration consists of the following xml elements:~~
	* '''smtp-host''' - server that will send the email
	* '''smtp-auth''' - authentication mechanism, if applicable
	** ''mail.smtp.auth'' - smtp protocol with smtp authentication
	** ''mail.smtps.auth'' - smtps protocol with smtps authentication
	** ''none''' - smtp protocol with '''no''' authentication
	* '''email-sender''' - valid email address
	* '''sender-password''' - not required

	~~[[Global_Configuration_Files#Send_Email_Command\|Send email command]] may be used to test the configuration values.~~

	~~==== Example Email Credentials Configuration ====~~

	~~<smtp-host>smtp.gmail.com/<smtp-host>~~
	~~<smtp-auth>mail.smtps.auth</smtp-auth>~~
	~~<email-sender>joe@mycompany.com</email-sender>~~
	~~<sender-password encrypted="false">mypassword</sender-password>~~

	~~=== Additional Email Configuration ===~~
	~~In addition, there are configuration settings for when to send out notification emails and whether or not to send out the 'No Files to Prep' email.~~
	* '''dashboard-url''' - Dashboard URL used as the link destination for the email Log In button
	* '''notify-changes-email-interval''' - By default, the ''Notification'' email may be sent every day. Since the project's Jenkins Notification job is only run once a week, this email will only be set out once a week.
	* '''late-kits-email-interval''' - By default, the ''Late Prep Kits'' email may be sent every day depending on the number of days late. Since the project's Jenkins Notification job is only run once a week, this email will be sent out once a week.
	* '''number-days-late''' - By default, a prep kit is deemed late if it is 7 days late.
	* '''send-no-files-to-prep-email''' - By default, the ''No Files to Prep'' email will be sent out when there is a request to prep a kit but there are no files to prep. If a Jenkins job is created that automatically attempts to prep a kit, then this value should be set to ''0'' so that the email is not sent. Otherwise, the email recipient's inbox may be inundated with 'No Files to Prep' emails.

	~~=== Java Options for sending emails ===~~
	~~It may be necessary to explicitly set the email port and/or STARTTLS flag rather than rely on the default mail server values. In addition, the email session debug mode can be enabled.~~

	~~There are 3 email settings that are set through java options:~~
	* Email Server Port
	* SMTP STARTTLS enabled
	* Email Session Debug mode enabled

	~~==== Email Protocol Port Number ====~~
	~~The expected java option for explicitly setting the protocol port number is:~~
	* mail.smtp.port

	~~Linux example if setting java options within a shell session.~~

	~~:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.port=25'</span>~~

	~~==== Enable/Disable STARTTLS ====~~
	~~The expected java option for explicitly enabling/disabling STARTTLS is:~~
	* mail.smtp.starttls.enable

	~~Linux example if setting java options within a shell session.~~

	~~:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.starttls.enable=true'</span>~~

	~~==== Enable Email Session Debug mode ====~~
	~~The expected java option for explicitly enabling/disabling the email session debug mode is:~~
	* mail.debug.mode

	~~Linux example if setting java options within a shell session.~~

	~~:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.debug.mode=true'</span>~~

	~~=== Send Email Command ===~~
	~~The ''send email command'' is accessed through the lpcommon.jar file and is located in the <code>lib</code> folder (i.e. ../lrm-server-x.x/lib).~~

	~~=== Encrypted Password ===~~
	~~The <code><sender-password></code> can be configured with the <code>encrypted</code> attribute set to true, as in~~
	~~<pre>~~
	~~...~~
	~~<email-sender>mailuser@company.com</email-sender>~~
	~~<sender-password encrypted="true">UUIasd455</sender-password>~~
	~~...~~
	~~</pre>~~

	~~To encrypt the password, use the <code>encrypt</code> command line on <code>lrm-common.jar</code> file. For instance:~~

	~~'''<code>> java -jar <LRM_INSTALLATION_PATH>/lib/lpcommon.jar --encrypt</code>'''~~

	~~which will prompt you for the text (here the password) to encrypt and will provide the result on the console.~~

	== config_file_cherry_picker.xml ==		== config_file_cherry_picker.xml ==

Llawson: /* config_email_global.xml */

2017-09-08T21:11:05Z

config_email_global.xml

← Older revision		Revision as of 21:11, 8 September 2017
Line 83:		Line 83:

	The '''config_email_global.xml''' file is used by a project's ''Notifications'' Jenkins job in order to send out status emails. This Jenkins job is, by default, set to run once a week.		The '''config_email_global.xml''' file is used by a project's ''Notifications'' Jenkins job in order to send out status emails. This Jenkins job is, by default, set to run once a week.

			See [[Sending_Emails \| Sending Emails]] for more information.

	There are 3 types of information contained in the ''config_email_global.xml'' file.		There are 3 types of information contained in the ''config_email_global.xml'' file.

Llawson: /* Java Options for sending emails */

2017-09-08T21:06:40Z

Java Options for sending emails

← Older revision		Revision as of 21:06, 8 September 2017
Line 121:		Line 121:
	There are 3 email settings that are set through java options:		There are 3 email settings that are set through java options:
	* Email Server Port		* Email Server Port
	* SMTP ~~Starttls~~ enabled		* SMTP STARTTLS enabled
	* Email Session Debug mode enabled		* Email Session Debug mode enabled

Line 132:		Line 132:
	:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.port=25'</span>		:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.port=25'</span>

	==== STARTTLS ~~Enabled~~ ====		==== Enable/Disable STARTTLS ====
	The expected java option for explicitly enabling/disabling STARTTLS is:		The expected java option for explicitly enabling/disabling STARTTLS is:
	* mail.smtp.starttls.enable		* mail.smtp.starttls.enable
Line 139:		Line 139:

	:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.starttls.enable=true'</span>		:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.starttls.enable=true'</span>

			==== Enable Email Session Debug mode ====
			The expected java option for explicitly enabling/disabling the email session debug mode is:
			* mail.debug.mode

			Linux example if setting java options within a shell session.

			:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.debug.mode=true'</span>

	=== Send Email Command ===		=== Send Email Command ===

Llawson: /* Java Options for sending emails */

2017-09-08T21:04:01Z

Java Options for sending emails

← Older revision		Revision as of 21:04, 8 September 2017
Line 120:		Line 120:

	There are 3 email settings that are set through java options:		There are 3 email settings that are set through java options:
	* Email Server Port ~~- "mail.smtp.port"~~		* Email Server Port
	* SMTP Starttls enabled ~~- "mail.smtp.starttls.enable"~~		* SMTP Starttls enabled
	* Email Session Debug mode enabled ~~= "mail.debug.mode"~~		* Email Session Debug mode enabled

	==== Email Protocol Port Number ====		==== Email Protocol Port Number ====

Llawson: /* Java Options for sending emails */

2017-09-08T21:03:13Z

Java Options for sending emails

← Older revision		Revision as of 21:03, 8 September 2017
Line 123:		Line 123:
	* SMTP Starttls enabled - "mail.smtp.starttls.enable"		* SMTP Starttls enabled - "mail.smtp.starttls.enable"
	* Email Session Debug mode enabled = "mail.debug.mode"		* Email Session Debug mode enabled = "mail.debug.mode"

			==== Email Protocol Port Number ====
			The expected java option for explicitly setting the protocol port number is:
			* mail.smtp.port

			Linux example if setting java options within a shell session.

			:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.port=25'</span>

			==== STARTTLS Enabled ====
			The expected java option for explicitly enabling/disabling STARTTLS is:
			* mail.smtp.starttls.enable

	Linux example if setting java options within a shell session.		Linux example if setting java options within a shell session.

	:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-~~Dftp~~.~~proxyHost=theproxyhost -Dftp~~.~~proxyPort~~=~~123~~'</span>		:: <span style="background-color: #eaecf0;>export _JAVA_OPTIONS='-Dmail.smtp.starttls.enable=true'</span>

	=== Send Email Command ===		=== Send Email Command ===

Llawson: /* Java Options for sending emails */

2017-09-08T20:54:09Z

Java Options for sending emails

← Older revision		Revision as of 20:54, 8 September 2017
Line 117:		Line 117:

	=== Java Options for sending emails ===		=== Java Options for sending emails ===
	It may be necessary to explicitly set the email port or ~~the~~ STARTTLS flag rather than rely on the default mail server values.		It may be necessary to explicitly set the email port and/or STARTTLS flag rather than rely on the default mail server values. In addition, the email session debug mode can be enabled.

	There are 3 settings that are set through java options:		There are 3 email settings that are set through java options:
	* Email Server Port - "mail.smtp.port"		* Email Server Port - "mail.smtp.port"
	* SMTP Starttls enabled - "mail.smtp.starttls.enable"		* SMTP Starttls enabled - "mail.smtp.starttls.enable"

Llawson: /* Java Options for sending emails */

2017-09-08T20:53:12Z

Java Options for sending emails

← Older revision		Revision as of 20:53, 8 September 2017
Line 118:		Line 118:
	=== Java Options for sending emails ===		=== Java Options for sending emails ===
	It may be necessary to explicitly set the email port or the STARTTLS flag rather than rely on the default mail server values.		It may be necessary to explicitly set the email port or the STARTTLS flag rather than rely on the default mail server values.
	~~These values~~ are set through java options.
			There are 3 settings that are set through java options:
			* Email Server Port - "mail.smtp.port"
			* SMTP Starttls enabled - "mail.smtp.starttls.enable"
			* Email Session Debug mode enabled = "mail.debug.mode"

	Linux example if setting java options within a shell session.		Linux example if setting java options within a shell session.