Both sides previous revisionPrevious revisionNext revision | Previous revision |
module:tickit [2020/09/17 01:03] – [See Also] digital man | module:tickit [2022/03/05 00:39] (current) – Fine tuning on AutoAreas Mewcenary |
---|
====== TickIT ====== | ====== TickIT - FidoNet TIC File Processor ====== |
| |
TickIT (''[[dir:exec]]/tickit.js'') is a simple incoming TICK (TIC File) processor for Synchronet. | TickIT (''[[dir:exec]]/tickit.js'') is a simple incoming TICK (TIC File) processor for Synchronet. |
| |
Managing ''[[dir:ctrl]]/tickit.ini'' may be done manually or via ''[[dir:exec]]/tickitcfg.js''. The preferred method is via [[module:tickitcfg|tickitcfg]] which allows for importing your FDN areas as well as access to global and per area options. | Managing ''[[dir:ctrl]]/tickit.ini'' may be done manually or via ''[[dir:exec]]/tickitcfg.js''. The preferred method is via [[module:tickitcfg|tickitcfg]] which allows for importing your FDN areas as well as access to global and per area options. |
| |
TickIT automatically executes ''[[dir:exec]]/addfiles'' when it processes files sent to your system in FDN areas stored in your file bases. Addfiles is executed for each file as it is processed. Files stored outside of your file bases will not have addfiles run against them during processing. | |
| |
In a recent change to SBBSecho/EchoCfg v3 and ''tickit.js'', the TIC file password for each FTN-linked node is now stored in the ''TicFilePwd'' key of the corresponding ''[node]'' section of the ''[[config:sbbsecho.ini]]'' file and can be managed via AreaFix and via ''[[util:echocfg]]''. | In a recent change to SBBSecho/EchoCfg v3 and ''tickit.js'', the TIC file password for each FTN-linked node is now stored in the ''TicFilePwd'' key of the corresponding ''[node]'' section of the ''[[config:sbbsecho.ini]]'' file and can be managed via AreaFix and via ''[[util:echocfg]]''. |
| |
===== Setup ===== | ===== Install ===== |
| |
You should create an event to run it when you get .TIC files... | You should create an event to run it when you get .TIC files... |
* [[module:binkit|BinkIT]] automatically runs the TICKIT timed event when a TIC file is received | * [[module:binkit|BinkIT]] automatically runs the TICKIT timed event when a TIC file is received |
* If you would like to treat all imported ''.tic'' files as though they have a ''REPLACES'' clause, add the ''-force-replace'' option to the ticket.js command-line or use the ''Force Replace'' options in tickitcfg for global or per-area forced replacements | * If you would like to treat all imported ''.tic'' files as though they have a ''REPLACES'' clause, add the ''-force-replace'' option to the ticket.js command-line or use the ''Force Replace'' options in tickitcfg for global or per-area forced replacements |
===== Configuration ===== | |
| ===== Invoke ===== |
| |
| ''tickit.js'' may be executed via [[util:JSexec]] or via timed event (as shown in the [[#Install]] section). |
| |
| ==== Command-line Syntax ==== |
| |
| tickit.js [cfg-file=tickit.ini] [-options] |
| |
| ^ Option ^ Description ^ |
| | -force-replace | Always replace existing files of the same name in the same directory | |
| | -debug | Enable extra debug-level log messages | |
| |
| The default configuration file is ''[[dir:ctrl]]/tickit.ini''. To use an alternate configuration file (but still located in the ''[[dir:ctrl]]'' directory), pass that filename on the command-line (not the full path, just the filename). Example: |
| jsexec tickit.js alt_tickit.ini |
| |
| ===== Configure ===== |
| |
==== ctrl/tickit.ini ==== | ==== ctrl/tickit.ini ==== |
| ''ForceReplace'' | Set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases. It should be used with caution. | | | ''ForceReplace'' | Set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases. It should be used with caution. | |
| ''Uploader'' |Default uploader name to be used in the files' database records | | | ''Uploader'' |Default uploader name to be used in the files' database records | |
| ''AutoAreas'' |Set to a comma-separated list of File Library names which should be automatically added to the list of areas in your TickIT configuration (the directory names must be valid AreaTags) | | | ''AutoAreas'' |Set to a comma-separated list of File Library Short Names (case sensitive) which should be **automatically** added to the list of areas in your TickIT configuration. When incoming TICs are processed, the AREA tag must match the ''FidoNet Area Tag'' as defined in scfg. | |
| |
**NOTE:** ''Path'' and ''Dir'' cannot be used together. | **NOTE:** ''Path'' and ''Dir'' cannot be used together. |
* [[TickFix]] | * [[TickFix]] |
| |
{{tag>fidonet tic tick raid}} | {{tag>fidonet tic tick raid jsutil}} |
| |