| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| module:tickit [2019/07/29 19:44] – [ctrl/tickit.ini] add Sample FDN Area Definition section wkitty42 | module:tickit [2019/07/30 04:58] – [ctrl/tickit.ini] add missing options and clarifications wkitty42 |
|---|
| * ''Dir'' Default BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. | * ''Dir'' Default BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. |
| * ''Links'' Comma-separated list of FTN addresses to forward *all* files to. | * ''Links'' Comma-separated list of FTN addresses to forward *all* files to. |
| * ''IgnorePassword'' Set to true to ignore the password in the TIC file along with the packet password for the node. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases, so should be used with caution (and only used with SecureOnly). | * ''IgnorePassword'' Set to true to ignore the password in the TIC file. This will allow anyone who can send a TIC file to your board to do so even if they are not configured as one of your linked systems. It should be used with extreme caution (and only used with SecureOnly). Global setting only; not overridden per FDN definition |
| * ''SecureOnly'' Set to true to only import TIC files from the secure inbound. | * ''SecureOnly'' Set to true to only import TIC files from the secure inbound. Global setting only; not overridden per FDN definition |
| * ''Handler'' Set to the filename of a handler script as defined below. | * ''Handler'' Set to the filename of a handler script as defined below. |
| * ''HandlerArg'' a string that is passed to the handler function. | * ''HandlerArg'' a string that is passed to the handler function. |
| | * ''AddFilesLogCap'' used to capture addfiles output into a log for debug and troubleshooting. Global setting only; not overridden per FDN definition |
| | * ''SourceAddress'' a FTN address to send *all* files from when you are feeding FDNs to other systems. |
| | * ''AKAMatching'' set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. |
| | * ''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'' provides a default uploader name to be used in the files' database records |
| | |
| | **NOTE:** ''Path'' and ''Dir'' cannot be used together. |
| |
| ''Path'' and ''Dir'' cannot be used together. | |
| |
| === Sections === | === Sections === |
| |
| Each section is a FDN area. This must match the AREA tag in the TIC file. Each area supports the following options: | Each section is a FDN area definition. This must match the AREA tag in the TIC file. Each area supports the following options: |
| |
| * ''Path'' Local path to store files in. If this is set, the file will NOT be imported into a local sub. | * ''Path'' Local path to store files in. If this is set, the file will NOT be imported into a local sub. |
| * ''Handler'' Set to the filename of a handler script as defined below. If present, this overrides the global Handler, they do not both run. | * ''Handler'' Set to the filename of a handler script as defined below. If present, this overrides the global Handler, they do not both run. |
| * ''HandlerArg'' a string that is passed to the handler function. | * ''HandlerArg'' a string that is passed to the handler function. |
| | * ''SourceAddress'' a FTN address to send files from when you are feeding this area to other systems. |
| | * ''AKAMatching'' set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. |
| | * ''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. |
| | * ''Uploader'' provides an uploader name for this FDN area |
| | |
| |
| === Sample FDN Area Definition === | === Sample FDN Area Definition === |
| The Links line should contain at least one FTN address. This will be the address of your feed for the FDNs you carry. Every system that you link this area to will be listed as shown above. No spaces are allowed and each FTN address must be complete. I generally put the addresses in numerical order with the first address listed being the main linked system feeding the area. This is not set in stone. You can list the addresses in any order you like. | The Links line should contain at least one FTN address. This will be the address of your feed for the FDNs you carry. Every system that you link this area to will be listed as shown above. No spaces are allowed and each FTN address must be complete. I generally put the addresses in numerical order with the first address listed being the main linked system feeding the area. This is not set in stone. You can list the addresses in any order you like. |
| |
| See the below Handler section for the definition of what the file handler lines do. | See the below [[tickit#nodelist_handlerjs|nodelist_handler]] subsection in the [[tickit#included_handler_scripts|Handler Scripts]] section for the definition of what the file handler related lines do. |
| |
| The SourceAddress is an override field if you want this area to be distributed from a different FTN address than your main one. Your main FTN address is the first one listed in scfg in the fidonet network configuration section. Each of your fidonet technology addresses will be listed in that same section all together. | The SourceAddress is an override field if you want this area to be distributed from a different FTN address than your main one. Your main FTN address is the first one listed in scfg in the fidonet network configuration section. Each of your fidonet technology addresses will be listed in that same section all together. |
| Dir=DAILYLIST | Dir=DAILYLIST |
| Handler=tickit/nodelist_handler.js | Handler=tickit/nodelist_handler.js |
| HandlerArg={"domain":"fidonet", "match":"NODELIST.Z*", "nlmatch":"nodelist.*"} | HandlerArg={"domain":"fidonet", "match":"Z1DAILY.Z*", "nlmatch":"Z1DAILY.*"} |
| </code> | </code> |
| |
| * ''match'' the filespec for nodelist archives in this area. If the incoming file doesn't match this, the nodelist is not updated. This defaults to '*.*' on Windows and '*' everywhere else. | * ''match'' the filespec for nodelist archives in this area. If the incoming file doesn't match this, the nodelist is not updated. This defaults to '*.*' on Windows and '*' everywhere else. |
| * ''nlmatch'' the filespec for the nodelist file inside the archive. There must be exactly one file matching this filespec inside the archive, or the nodelist will not be updated. . This defaults to '*.*' on Windows and '*' everywhere else. | * ''nlmatch'' the filespec for the nodelist file inside the archive. There must be exactly one file matching this filespec inside the archive, or the nodelist will not be updated. . This defaults to '*.*' on Windows and '*' everywhere else. |
| | |
| | **NOTE:** This handler will attempt to extract the nlmatch file from the match archive and write it to the directory and file name as defined in echocfg in the Domains definition section. The file will always be saved to the defined name and it will not be changed unless you change the Domain definition in echocfg. The domain argument must also be one defined in echocfg. |
| |
| ===== See Also ===== | ===== See Also ===== |
