Configuration System - Revision history

Sam: /* Adding a Setting */

2026-04-16T10:12:39Z

Adding a Setting

Sam: /* Adding a Setting */

2026-04-16T10:09:45Z

Adding a Setting

Sam at 10:08, 16 April 2026

2026-04-16T10:08:37Z

Sam at 09:44, 16 April 2026

2026-04-16T09:44:16Z

Sam: /* Database by Machine */

2024-01-29T10:34:10Z

Database by Machine

Sam: /* Database by Machine */

2022-07-27T17:16:41Z

Database by Machine

Sam: /* Sample Options Log */

2022-07-25T16:31:48Z

Sample Options Log

Show changes

Sam at 19:29, 24 February 2021

2021-02-24T19:29:56Z

Sam: /* Database by Machine */

2021-02-22T16:47:34Z

Database by Machine

Sam: /* Database by Machine */

2021-02-22T16:47:14Z

Database by Machine

@@ Line 341: / Line 341: @@
 ==Adding a Setting==
-Here's a basic <code>TruxtonSettings.xml</code> file:
+Here's a basic <code>[[#Truxton Settings File|TruxtonSettings.xml]]</code> file:
 <source lang="XML">
 <truxton_options>
@@ Line 357: / Line 357: @@
 We want to reduce our storage by saving a file's contents only once throughout all of Truxton.
 This is controlled by the <code>globaldedupe</code> option.
-We would edit the <code>TruxtonSettings.xml</code> file and add a new element to the <code>truxton_options</code> section.
+We would edit the <code>[[#Truxton Settings File|TruxtonSettings.xml]]</code> file and add a new element to the <code>truxton_options</code> section.
 <source lang="XML" highlight="2">

← Older revision		Revision as of 10:09, 16 April 2026
Line 373:		Line 373:
	</source>		</source>

−	Once you save the file, you must restart the [[Truxton service]] in order for the new settings to take affect.	+	Once you save the file, you must restart the [[Truxton Service\|Truxton service]] in order for the new settings to take affect.

← Older revision		Revision as of 10:08, 16 April 2026
Line 333:		Line 333:
	It looks like Windows Storage Spaces has limitations on [https://docs.microsoft.com/en-us/windows-server/storage/data-deduplication/whats-new deduplication] of volumes.		It looks like Windows Storage Spaces has limitations on [https://docs.microsoft.com/en-us/windows-server/storage/data-deduplication/whats-new deduplication] of volumes.
	It appears that the maximum volume size is 64TB while only the first 4TB of a file will be deduplicated.		It appears that the maximum volume size is 64TB while only the first 4TB of a file will be deduplicated.
		+
		+	=Configuration File Format=
		+	Truxton uses XML as the format for configuration.
		+	However, it uses it differently than most applications.
		+	Truxton will parse the specified XML file, then enumerate through all of the elements with a name of <code>truxton_options</code> and use only those sections of the file for configuration.
		+	This allows you to insert Truxton configuration into any XML file.
		+
		+	==Adding a Setting==
		+	Here's a basic <code>TruxtonSettings.xml</code> file:
		+	<source lang="XML">
		+	<truxton_options>
		+	<dbconnectionstring>Host=localhost;Port=5432;Database=Truxton;Username=postgres;Password=Password123;</dbconnectionstring>
		+	<mbconnectionstring>Host=localhost;Port=5432;Database=TruxtonMessageBus;Username=postgres;Password=Password123;</mbconnectionstring>
		+	<datadir>C:\Truxton Data</datadir>
		+	<tempdir>C:\Truxton Data\Temp\</tempdir>
		+	<sqlite_exploitation_scripts_folder>C:\Program Files\Truxton\Loader\SQLite Exploitation Scripts</sqlite_exploitation_scripts_folder>
		+	<machineid>9D6D69B5-2568-4CEC-B4D4-1A4B56FBA557</machineid>
		+	<solr_url>http://localhost:8983/solr/truxton-core</solr_url>
		+	<tesseract>C:\Program Files\Tesseract-OCR\tesseract.exe</tesseract>
		+	</truxton_options>
		+	</source>
		+
		+	We want to reduce our storage by saving a file's contents only once throughout all of Truxton.
		+	This is controlled by the <code>globaldedupe</code> option.
		+	We would edit the <code>TruxtonSettings.xml</code> file and add a new element to the <code>truxton_options</code> section.
		+
		+	<source lang="XML" highlight="2">
		+	<truxton_options>
		+	<globaldedupe>1</globaldedupe>
		+	<dbconnectionstring>Host=localhost;Port=5432;Database=Truxton;Username=postgres;Password=Password123;</dbconnectionstring>
		+	<mbconnectionstring>Host=localhost;Port=5432;Database=TruxtonMessageBus;Username=postgres;Password=Password123;</mbconnectionstring>
		+	<datadir>C:\Truxton Data</datadir>
		+	<tempdir>C:\Truxton Data\Temp\</tempdir>
		+	<sqlite_exploitation_scripts_folder>C:\Program Files\Truxton\Loader\SQLite Exploitation Scripts</sqlite_exploitation_scripts_folder>
		+	<machineid>9D6D69B5-2568-4CEC-B4D4-1A4B56FBA557</machineid>
		+	<solr_url>http://localhost:8983/solr/truxton-core</solr_url>
		+	<tesseract>C:\Program Files\Tesseract-OCR\tesseract.exe</tesseract>
		+	</truxton_options>
		+	</source>
		+
		+	Once you save the file, you must restart the [[Truxton service]] in order for the new settings to take affect.

@@ Line 10: / Line 10: @@
 The following are the nine different places that a parameter can come from. The lower the number, the greater the precedence that option has. The harder it is for a user to define an option, the greater weight that option will be given. It is harder for a user to specify an option on a command line because they must type it out. The user exerts no effort whatsoever to use a default value compiled into programs. Therefore, the command line option will be used instead of the compiled default.
-# Command Line Parameters
+# Command Line Parameters - Highest priority
 # Command Line Configuration File
 # Command Line Database
@@ Line 18: / Line 18: @@
 # Database by Machine
 # Truxton Settings File
-# Compiled Defaults
+# Compiled Defaults - Lowest priority
 ==Command Line Parameters==
@@ Line 57: / Line 66: @@
 The <code>my_settings.xml</code> would be assumed to be a file name since it was not part of an option.
-That file would then be opened, parsed as [https://en.wikipedia.org/wiki/XML XML] and anything found in a <code>truxton_options</code> section would be used as configuration options.
+That file would then be opened, parsed as [https://en.wikipedia.org/wiki/XML XML] and anything found in a <code>truxton_options</code> section will be used as configuration options.
 All XML element names used in Truxton are lower case.

@@ Line 113: / Line 113: @@
 ==Database by Machine==
 Each installation of Truxton has a globally unique machine identifier.
-This can be found in the <code>[[TruxtonObject#machineid|machineid]]</code> element of the <code>TruxtonSettings.XML</code> file.
+This can be found in the <code>[[TruxtonObject#machineid:_str]]</code> element of the <code>TruxtonSettings.XML</code> file.
 Truxton will connect to the database and query the <code>[Setting]</code> table for a record with the machine identifier in the <code>[ID]</code> column.
 If found, the XML in the <code>Value</code> column will be parsed for options.

@@ Line 134: / Line 134: @@
 With nine different places to get options from, how could anything go wrong? If you need help debugging why an option isn't getting the value you want, use the <code>debugoptions</code> option.
-<syntaxhighlight lang="bat">
+<source lang="bat">
 Identify.exe -debugoptions 1
-</syntaxhighlight>
+</source>
 This will cause an installation log to be created and the options written to it.

@@ Line 114: / Line 114: @@
 Each installation of Truxton has a globally unique machine identifier.
 This can be found in the <code>machineid</code> element of the <code>TruxtonSettings.XML</code> file.
-Truxton will connect to the database and query the <code>Setting</code> table for a record with the machine identifier in the <code>ID</code> column.
+Truxton will connect to the database and query the <code>[Setting]</code> table for a record with the machine identifier in the <code>ID</code> column.
 If found, the XML in the <code>Value</code> column will be parsed for options.