Improvements on config templates

src/config.template.cjs

@@ -4,14 +4,15 @@
 module.exports = {
 	/**
 	 * Pause at least this much in between each search. Higher is safer.
-	 * 	It is not recommended to set this to less than 2 seconds.
+	 * It is not recommended to set this to less than 2 seconds.
 	 */
 	delay: 10,
+
 	/**
-	 * List of Torznab urls.
-	 * The path should end in /api
+	 * List of Torznab URLs.
 	 * For Jackett, click "Copy RSS feed"
-	 * For Prowlarr, click (i) and copy the Torznab Url, then append "?apikey=YOUR_PROWLARR_API_KEY"
+	 * For Prowlarr, click on the indexer name and copy the Torznab Url, then append "?apikey=YOUR_PROWLARR_API_KEY"
+	 * Wrap each URL in quotation marks, and separate them with commas.
 	 */
 	torznab: [],
 
@@ -29,8 +30,8 @@ module.exports = {
 	matchMode: "safe",
 
 	/**
-	 * Defines what category torrents injected by data-based matching should use. Default is
-	 * cross-seed-data
+	 * Defines what category torrents injected by data-based matching should use.
+	 * Default is "cross-seed-data"
 	 */
 	dataCategory: undefined,
 
@@ -61,15 +62,15 @@ module.exports = {
 	maxDataDepth: 2,
 
 	/**
-	 * directory containing torrent files.
+	 * Directory containing torrent files.
 	 * For rtorrent, this is your session directory
 	 * as configured in your .rtorrent.rc file.
 	 * For deluge, this is ~/.config/deluge/state.
 	 */
 	torrentDir: "/path/to/torrent/file/dir",
 
 	/**
-	 * where to put the torrent files that cross-seed finds for you.
+	 * Where to put the torrent files that cross-seed finds for you.
 	 */
 	outputDir: ".",
 
@@ -113,8 +114,8 @@ module.exports = {
 	excludeRecentSearch: undefined,
 
 	/**
-	 * can be either "save" or "inject".
 	 * With "inject" you need to set up one of the below clients.
+	 * Options: "save", "inject"
 	 */
 	action: "save",
 
@@ -165,6 +166,7 @@ module.exports = {
 	/**
 	 * Bind to a specific host address.
 	 * Example: "127.0.0.1"
+	 * Default is "0.0.0.0"
 	 */
 	host: undefined,
 

src/config.template.docker.cjs

@@ -2,16 +2,16 @@
 // it here as a default.
 
 module.exports = {
-	/*
+	/**
 	 * Pause at least this much in between each search. Higher is safer.
-	 * 	It is not recommended to set this to less than 2 seconds.
+	 * It is not recommended to set this to less than 2 seconds.
 	 */
 	delay: 10,
 
 	/**
 	 * List of Torznab URLs.
 	 * For Jackett, click "Copy RSS feed"
-	 * For Prowlarr, click (i) and copy the Torznab Url, then append "?apikey=YOUR_PROWLARR_API_KEY"
+	 * For Prowlarr, click on the indexer name and copy the Torznab Url, then append "?apikey=YOUR_PROWLARR_API_KEY"
 	 * Wrap each URL in quotation marks, and separate them with commas.
 	 */
 	torznab: [],
@@ -27,16 +27,16 @@ module.exports = {
 	 * using the standard matching algorithm. "risky" uses filesize as its only comparison point.
 	 * Options: "safe", "risky"
 	 */
-	matchMode: undefined,
+	matchMode: "safe",
 
 	/**
-	 * Defines what category torrents injected by data-based matching should use. Default is
-	 * cross-seed-data
+	 * Defines what category torrents injected by data-based matching should use.
+	 * Default is "cross-seed-data"
 	 */
 	dataCategory: undefined,
 
 	/**
-	 * If this is enabled, cross-seed will create hardlinks to scanned files in the specified directory.
+	 * If this is specified, cross-seed will create links to scanned files in the specified directory.
 	 * It will create a different link for every changed file name or directory structure.
 	 */
 	linkDir: undefined,
@@ -62,7 +62,7 @@ module.exports = {
 	maxDataDepth: 2,
 
 	/**
-	 * directory containing torrent files.
+	 * Directory containing torrent files.
 	 * For rtorrent, this is your session directory
 	 * as configured in your .rtorrent.rc file.
 	 * For deluge, this is ~/.config/deluge/state.
@@ -72,7 +72,7 @@ module.exports = {
 	torrentDir: "/torrents",
 
 	/**
-	 * where to put the torrent files that cross-seed finds for you.
+	 * Where to put the torrent files that cross-seed finds for you.
 	 * Don't change this for Docker.
 	 * Instead set the volume mapping on your docker container.
 	 */
@@ -118,8 +118,8 @@ module.exports = {
 	excludeRecentSearch: undefined,
 
 	/**
-	 * can be either "save" or "inject".
 	 * With "inject" you need to set up one of the below clients.
+	 * Options: "save", "inject"
 	 */
 	action: "save",
 
@@ -170,6 +170,7 @@ module.exports = {
 	/**
 	 * Bind to a specific host address.
 	 * Example: "127.0.0.1"
+	 * Default is "0.0.0.0"
 	 */
 	host: undefined,