| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| module:binkit [2018/03/31 17:35] – Updated for BinkIT v2.0 (uses sbbsecho.ini for all settings) digital man | module:binkit [2020/11/11 22:06] (current) – [See Also] Added jsutil tag digital man |
|---|
| ====== BinkIT ====== | ====== BinkIT - FidoNet Mailer ====== |
| |
| BinkIT is a simple BinkP BSO/FLO-style FidoNet Mailer, written for Synchronet in JavaScript. BinkIT may be used in place of BinkD or other FidoNet mailers. | BinkIT is a simple BinkP BSO/FLO-style FidoNet [[ref:fidonet_glossary#Mailer]], written for Synchronet in JavaScript (by [[person:Deuce]]). BinkIT may be used in place of BinkD or any other [[resource:FidoNet mailer]]. |
| |
| ===== Features ==== | ===== Features ==== |
| |
| * BinkP 1.1 support (except for the undocumented No Dupes mode) | * BinkP 1.1 support (except for the undocumented No Dupes mode) |
| | * Supports operation over TLS (binkps) for both inbound and outbound sessions |
| * Supports BinkD compatible encryption | * Supports BinkD compatible encryption |
| * Supports secure CRAM-MD5 authentication | * Supports secure CRAM-MD5 authentication |
| * Nodelist support, can read the hostname and port number from a nodelist | * Nodelist support, can read the hostname and port number from a nodelist |
| |
| ===== Automated Install ===== | ===== Install ===== |
| |
| If you've already configured [[util:SBBSecho]] v3, you may perform an automated install of BinkIT from a command prompt by running "''[[dir:exec]]/[[util:jsexec]] binkit install''". | If you've already configured [[util:SBBSecho]] v3, you may perform an automated install of BinkIT from a command prompt by running "''[[dir:exec]]/[[util:jsexec]] binkit install''". |
| |
| This will update the ''[[dir:ctrl]]/sbbsecho.ini'' file for you and setup the necessary Timed Events in [[util:SCFG]], but you may need to edit the session passwords in ''sbbsecho.ini'' to match those expected by your links. | This will update the ''[[dir:ctrl]]/[[config:sbbsecho.ini]]'' file for you and setup the necessary Timed Events in [[util:SCFG]], but you may need to edit the session passwords in ''sbbsecho.ini'' to match those expected by your links. |
| |
| If your network links are not in FidoNet (i.e. reachable via the ''binkp.net'' domain), you may need to specify a NodeList for that domain or specify ''Host'' values for those linked nodes. | If your network links are not in FidoNet (i.e. reachable via the ''binkp.net'' domain), you may need to specify a NodeList for that domain or specify ''Host'' values for those linked nodes. |
| |
| | ===== Upgrade to BinkIT v2 ===== |
| | |
| | If you've already setup BinkIT 1.x (e.g. using ''binkit.ini''), after updating your ''[[dir:exec]]/*.js'' and ''[[dir:load]]/*.js'' files to the latest (including ''binkit.js'' v2.x), you'll need to migrate your ''binkit.ini'' and ''ftn_domains.ini'' settings in ''sbbsecho.ini''. This can be done automatically by running "''[[dir:exec]]/[[util:jsexec]] binkit upgrade''". |
| | |
| | If you wish to perform the merge by hand, here are the changes: |
| | |
| | ^ Old ''binkit.ini'' key ^ New ''sbbsecho.ini'' key ^ |
| | | root ''Capabilities'' | ''[BinkP] Capabilities'' | |
| | | root ''Sysop'' | ''[BinkP] Sysop'' | |
| | | ''[//address//] Password'' | ''[node://address//] SessionPwd'' | |
| | | ''[//address//] Host'' | ''[node://address//] BinkpHost'' | |
| | | ''[//address//] Port'' | ''[node://address//] BinkpPort'' | |
| | | ''[//address//] Poll'' | ''[node://address//] BinkpPoll'' | |
| | | ''[//address//] AllowPlainPassword'' | ''[node://address//] BinkpAllowPlainAuth'' | |
| | | ''[//address//] AllowUnencrypted'' | ''[node://address//] BinkpAllowPlainText'' | |
| | | ''[//address//] SourceAddress'' | ''[node://address//] BinkpSourceAddress'' | |
| | |
| | The domain sections keys are unchanged, but the domain sections now require a ''domain:'' prefix: |
| | |
| | ^ Old ''ftn_domains.ini'' section ^ New ''sbbsecho.ini'' section ^ |
| | | ''[//name//]'' | ''[domain://name//]'' | |
| | |
| | Once the upgrade is complete, all of the BinkIT and [[util:SBBSecho]] configuration parameters can then be viewed and modified using the [[util:EchoCfg]] utility. |
| | |
| ===== Manual Setup ===== | ===== Manual Setup ===== |
| |
| |
| * ''SessionPwd'' sets the BinkP //session password// for the link (Usually the only required option) | * ''SessionPwd'' sets the BinkP //session password// for the link (Usually the only required option) |
| * ''BinkpAllowPlainAuth'' allows this link to insecurely send the password on the connection. Defaults to ''false''. **Not recommended** | * ''BinkpPlainAuthOnly'' Forces outbound sessions with this link to use plain-password authentication (not CRAM-MD5). Defaults to ''false''. |
| * ''BinkpAllowPlainText'' allows this link to use an unencrypted (plain-text) session. Defaults to ''false''. **Not recommended** | * ''BinkpAllowPlainAuth'' allows this link to insecurely send the password on the connection. Defaults to ''false''. |
| | * ''BinkpAllowPlainText'' allows this link to use an unencrypted (plain-text) session. Defaults to ''true''. |
| * ''BinkpSourceAddress'' the outbound **FTN** address to use for this link. Not normally needed, but can be used if multiple addresses are used in the same net with different passwords. Defaults to the "closest" FTN address to the link address. | * ''BinkpSourceAddress'' the outbound **FTN** address to use for this link. Not normally needed, but can be used if multiple addresses are used in the same net with different passwords. Defaults to the "closest" FTN address to the link address. |
| * ''BinkpPort'' TCP port to connect to when making an outbound connection on this link. Defaults to the port specified in the domain's nodelist, if configured, or the default BinkP port of 24554. | * ''BinkpPort'' TCP port to connect to when making an outbound connection on this link. Defaults to the port specified in the domain's nodelist, if configured, or the default BinkP port of 24554. |
| For compatibility with links using the BinkP implementation in Mystic BBS version 1.12A39, you must set ''BinkpAllowPlainText=true''. | For compatibility with links using the BinkP implementation in Mystic BBS version 1.12A39, you must set ''BinkpAllowPlainText=true''. |
| |
| ==== Example sbsbecho.ini ==== | **Note**:\\ |
| | For more details on the BinkP session-security related settings, see the documentation for ''sbbsecho.ini'' -> [[config:sbbsecho.ini#Node Sections]]. |
| | |
| | ==== Example sbbsecho.ini ==== |
| |
| <code ini> | <code ini> |
| ==== freqit.ini ==== | ==== freqit.ini ==== |
| |
| BinkIT integrates [[util:freqit|util:freqit]] functionality, so the ''freqit.ini'' file is used. | BinkIT integrates [[FreqIT]] functionality, so the ''freqit.ini'' file is used. |
| | |
| | ==== binkstats.ini ==== |
| |
| | Not technically a configuration file, the ''[[dir:data]]/binkstats.ini'' file contains cumulative statistics about all inbound and outbound BinkP connections made by BinkIT. |
| ==== Domains ==== | ==== Domains ==== |
| |
| </file> | </file> |
| |
| This error means that the remote/peer doesn't support encryption and encryption is required (by default). To loosen this requirement and allow a plain-text/un-encrypted session with this link, ''BinkpAllowPlainText=true'' for that linked node in your ''sbbsecho.ini'' file. | This error means that the remote/peer doesn't support encryption and encryption is required. To loosen this requirement and allow a plain-text/un-encrypted session with this link, set ''BinkpAllowPlainText=true'' for that linked node in your ''sbbsecho.ini'' file. |
| ===== See Also ===== | ===== See Also ===== |
| * [[:module:|Modules index]] | * [[:module:|Modules index]] |
| * [[util:freqit|FREQIT]] | * [[module:FreqIT]] (file request module) |
| * [[util:tickit|TickIT]] | * [[module:TickIT]] (TIC file processor) |
| * [[util:hatchit|HatchIT]] | * [[module:HatchIT]] (TIC file hatcher) |
| | * [[util:SBBSecho]] (EchoMail program) |
| | * [[config:sbbsecho.ini]] (SBBSecho configuration file) |
| | * [[util:EchoCfg]] (SBBSecho configuration utility) |
| |
| {{tag>fidonet binkp sbbsecho mailer}} | {{tag>fidonet binkp sbbsecho mailer jsutil}} |
| |
