# Sample BINKD.CFG File To Connect To The Eastern Star Mail Hub.
#       
# Lines beginning with the pound sign '#' are ignored by the daemon.
#
# This CONFIG File generally uses this format:
#
# Keyword <value> 
#
# [Note For Windows/DOS/OS2 Users]
#
# Path specifications to either a directory or to a file must be specified using
# double backslashes "\\", example:
#
# c:\\path\\to\\wherever
#
# Linux/*BSD users can use the standard path specifications.
#
# /path/to/wherever
#
# For purposes of this cfg, since the majority of my links do not run under a *nix OS, I
# am showing examples pertinent to Windows/DOS or OS2 users. If you are running under a *nix
# OS, simple specify path names accordingly.
#
# The cfg is broke down in sections, prefaced by an explanation of what it is for, what the keyword
# and values mean and their format. I then show an example, in most cases the example is not commented 
# out, requiring you to merely edit it or even to leave it alone. In some cases, an example is provided
# requiring you to edit it if you want to enable that feature and then remove the # sign that is commenting 
# out. Towards the end, their will be one section with 3 examples, requiring you to choose one, edit it and 
# uncomment it out.
#
# There will be some mandatory edits on your part, these will be marked as such:
#
# "!!!Edit this accordingly
#
# There are also portions that contain items that you can edit and/or use optionally, but leaving them as is
# if you dont need them is ok, these items will be marked as such:
#
# "***Edit this optionally"
#
#===================================================================================================================
#
# Lets get started, everything below this point is for real.
#
# Lets set your domain, domain aliases and outbound directory, what I show uncommented
# is for example usages only, you will have to change these values to match your particular
# setup.
#
# Format: domain domain_name path_to_outbound_directory zone
#
#                     domain = Keyword to set your domain with.
#                domain_name = Actual name of the domain, typically it is fidonet, but if you belong to
#                              other networks, specify that here, once for every network. Since this file
#                              is about configuring yourself to connect to The Eastern Star, fidonet is all
#                              that needs to be specified here.
# path_to_outbound_directory = This is where your tosser is configured for its outbound directory
#                              which is normally where it puts outbound mail and files.
#                       zone = This is your Zone, it is the same number as the number to the left of the semicolon
#                              in your node number. Fidonet Zones however are as follows:
#              
#                                          North America = 1
#                                 Europe And Middle East = 2
#                              Australia And New Zealand = 3
#                              Central And South America = 4
#                                                 Africa = 5
#                                                   Asia = 6 (This is technically a defunct zone now)
# 
# !!!Edit this accordingly
#
domain fidonet  c:\\fidonet\\mailer\\out 1
#
# These commands allow you to account for other domain names others might use within Fidonet as 
# a domain name, by aliasing them to just the word fidonet. You do not need to edit anything here
# unless you wish to add other alias definitions for fidonet or other networks, but the following
# alias definitions adequately cover fidonet.
#
# ***Edit this optionally
domain fido alias-for fidonet
domain fidonet.org alias-for fidonet
domain fidonet.net alias-for fidonet
#
# Your Fidonet Node Number
#
# Here you can put your Fidonet Addresses, you can specify the 'address' keyword multiple times, once
# for each of your node numbers in fidonet, assuming you have more than one, you however should list the
# primary address you plan to use to exchange mail with first.
#
# Format: address nodenumber@domain
#
# address = Keyword to set your Fidonet Address with
# nodenumber = 1:123/456
# @ = Self Explanatory
# domain = fidonet (in this case)
#
# !!!Edit this accordingly
address 1:123/456@fidonet
#
# Your System Information.
#
# The below examples are self-explanatory, follow the same format and enclose your information within 
# "quotes", as a rule of thumb throughout this cfg file, multi word values requiring a space between each word
# must be encapsulated within quotes. "  ".
#
# !!!Edit this accordingly
sysname "The Eastern Star Reading Node"
location "Spartanburg, SC USA"
sysop "Ross Cassell"
#
# System capabilities
#
# You can generally leave this information alone if you are using a broadband internet connection, else you can
# optionally change the first numeric value to match your dial up modem top speed, if your access to the internet 
# is dial-up?
#
# ***Edit this optionally
nodeinfo 115200,TCP,BINKP
#
# TCP settings. 
#
# Here you can set the TCP port that binkd can listen on for incoming connections or transmit on when it makes an
# outbound connection. Ordinarily if you run a standard setup, you do not even have to set these values at all or 
# you can expose the keywords and leave them as shown, but commented out, binkd will use the default port numbers
# to send and receive on. The default port binkd uses is 24554. If you are running behind a firewall be sure to expose
# this port for incoming connections if you are setting up for inbound connections. Further more, if you are behind a router
# be sure to port forward this port number to the machine on your LAN running binkd. Even if you need to change these values,
# normally only the iport one needs to be changed.
#
# Format: iport port_number
#
#       iport = Keyword
# port_number = The TCP port you wish to use instead, default is 24554 but could be anything you like, this only really needs
#               to be used if the default port is already in use.
#
# ***Edit this optionally, uncomment iport and see above example.    
#iport 
#
# ***Edit this optionally, you dont really need to change this value. Uncomment and see example for iport.
#oport binkp
#
# Miscellaneous setting.
#
# The settings that follow are generally tweaks that you can normally leave as is.
#
# ***Edit this optionally
oblksize 4096
timeout 60
call-delay 60
rescan-delay 60
maxservers 5
maxclients 5
try 10
hold 600
hold-skipped 3600
backresolv
#
# Path and name for the logfile, loglevel
#
# This is where you will want binkd to put its log file, you can use the log file to determine issues with the program or
# with a connection. You can even use a tail program to follow the log in real time. Tail programs are available for most 
# operating systems.
#
# !!!Edit this accordingly
log c:\\fidonet\\mailer\\logs\\binkd.log
# You can leave this setting as is, it allows the logging of ample info to track any issue.
loglevel 4
#
#
# Log pid:
#
# This is simply a text file that contains a process id number, normally windows users wont need this, except to identify
# the process number that that instance of binkd is running under. Windows users can more quickly terminate binkd my killing
# it in the service management console if they installed it as a service or by merely using the task manager. Linux users will find 
# this more useful as the scripts can read this file to obtain the id number and then terminate the instance of binkd. However regardless
# of the OS, it harms nothing to let binkd create this file, you can create it anywhere but if unsure just use the same directory that
# the binkd executable is located in.
#
# !!!Edit this accordingly
pid-file c:\\fidonet\\mailer\\binkd.pid
#
#
# Inbound directory for secure and non-secure links
#
# This is where you will want to tell binkd where you want to receive your mail and files in, this will also be the directory that your tosser
# will look in to process your mail and other files from. There are 2 separate entries you can make here:
#
# Format: inbound path
# Format: inbound-nonsecure path
#
#           inbound = Will be mail and files you receive from links you have passwords with, also known as secure links.
# inbound-nonsecure = Where files from nodes you have no password with are placed.
#              path = The directory that you wish to receive the relevant files in.
#
# Optionally you can use the same directory for both keywords but this doesnt protect you from receiving and then processing mail
# from untrustworthy sources. Under most Fidonet setups, when setup properly, the only thing your tosser will process from the unsecure
# directory is normally only netmail.
#
# !!!Edit this accordingly
inbound c:\\fidonet\\mailer\\in
inbound-nonsecure c:\\fidonet\\mailer\\unsec
#
# Binkd will skip all files from a node if
# size_of_the_next_file_for_us_there + minfree < free_space_in_inbound
#
# If you have disk space constraints, the following 2 keywords should provide a safety cushion so that your system isnt filled up.
# leaving this set as shown will suffice, nowadays with hdd's in the hundreds of gigabytes, this is hardly an issue anymore. The values
# shown are in kilobytes, so 2048 kilobytes is equal to 2 megabytes.
#
# ***Edit this optionally and only if you have to or want to.
minfree 2048
minfree-nonsecure 2048
#
# These settings affect how binkd deals with the inbound directory, you can leave these settings alone.
#
kill-dup-partial-files
kill-old-partial-files 86400
kill-old-bsy 43200
#
# Create a flag file after receiving a file
#
# Here you can instruct binkd to create a zero byte semaphore file that can be used to trigger events being monitored by another program based
# on the files it received. Many task schedulers and Fidonet mailers can be set to react when the presence of a file they are set to watch is created
# or if its time stamp has been changed/updated. Windows users might be interested in ROBOTASK or Linux users, incron. 
#
# Format: flag flagfilename file_mask
#
#         flag = Keyword
# flagfilename = Path and filename of the flag file to be created or touched, path is optional and if omitted then binkd's working directory is used.
#    file_mask = file mask to test for, when binkd receives a file that satisfies the mask, it will then create or update its time stamp of the specified 
#                flag file name. Said mask could be something as simple as *.* which means any file you could receive, it could be *.pkt, which means any file
#                that has the pkt extension or you could even use a fully qualified filename, which means it will only react using that name.
#
# For purposes of fidonet, the example below will suffice, simply edit the path and file name of the flag file and uncomment the line.
#
# ***Edit this optionally
#flag c:\\fidonet\\flags\\newmail.flg *.su? *.mo? *.tu? *.we? *.th? *.fr? *.sa? *.pkt *.tic
#
# Run an external program.
#
# This works much the same as the flag keyword above, except that instead of creating or updating a flag file when a certain file is received based on a 
# specific file mask, a program, script or batch file can be executed instead. Linux users will see the executed script occur seamlessly in the background
# while Windows users might see a console window pop open then shut.
#
# Format: exec "program_to_run" file_mask
#
#             exec = Keyword
# "program_to_run" = Path to Batch file, script or batch file, with command line arguments if needed, all enclosed in quote marks " ".
#        file_mask = Same logic for file masks as described in the flag section and shown below in the example.
#
# ***Edit this optionally, uncomment and make appropriate changes.
#exec "c:\\fidonet\\mailer\\bats\\mailtoss.bat" *.su? *.mo? *.tu? *.we? *.th? *.fr? *.sa? *.tic *.pkt
#
# Include a file
#
# Here you can direct binkd to read in additional configuration files, this is usually to accommodate a master list of Fidonet nodes that
# is distributed via Fidonet that comes preformatted in the method binkd can understand, generally you will not need to use this feature.
#
# ***Edit this optionally, uncomment and make the desired changes
#include binkd.inc
#include c:\\fidonet\\mailer\\binkd.txt
#
#
# Define a link:
#
# You are almost done, what follows is the original commentary to define a link, I will show an example that will include most of the needed
# settings to set your link with The Eastern Star Mail Hub.
#
#       node [[z:]n/]n[.p][@domain] [-nr] [{hosts|-} [{pwd|-} [flavour [{obox|-} [{ibox|-}]]]]]
#
# * All non-"-" fields will redefine values specified for the same node
# earlier in config.
# * Flavour is one of i, c, d, -, h; and is the flavour for the outbound
#  filebox ("obox").
# * Binkd sends from obox all non-dir entries NOT matching ".*" wildcard.
# EVERY TIME YOU PUT A FILE INTO OBOX CHECK IF BINKD WILL BE ABLE TO
# UNLINK IT. Otherwise, the session will never end.
# * Default for ibox is inbound or inbound-nosecure depending on the pwd field.
# * Default for port is oport.
# * `-nr' stands for `Not Reliable Link', this works only on outbound calls
# with another binkp/1.1 mailer. The option solves the only problem with
# binkd having no enough time to start receiving of a file from
# non-zero offset before IP link's down, so don't use it unless you
# have this problem -- really not effective
# * Hosts is a list in form
#       host1[:port1][;host2[:port2]] ...
# * Asterisk (`*') in the host list forces Binkd to perform
#       1:2/3.4 --> p4.f3.n2.z1.fidonet.net translation for a node's
#       Fido-address and lookup IP for the resulting FQDN in DNS.
#       Root domain part ("fidonet.net") can be changed with root-domain
#       keyword.
#
# If you use file boxes, create the directory you will use for each downlink before you start binkd.
#
# File Boxes
#
# File boxes are optional features of binkd. There are two type you can use, an outbox and a inbox.
# 
# Outbox = If specified, binkd will transmit to the link any file that shows up in this directory and then
#          delete it once transmitted successfully.
#  Inbox = If Specified, binkd will receive any files from that link into the specified directory, you will have to
#          have your software or setup configured to process files from this directory as it normally will look in the
#          secure or non-secure inbound directories already configured further above. Ordinarily most wont use this feature
#          and for purposes of this link, you wont need it. I dont use inboxes for the mailhub. (I do use outboxes, each link has one)
#
# The advantages of using an outbox means I can keep mail meant for each link in a separate directory, as opposed to lumping everyones
# mail together in one directory, as an individual link, you may not need this feature and most dont use it, but if your tosser doesnt
# directly support a Binkley Style Outbound but can pack mail for a link in a special directory, then this feature is handy. If your software
# supports a Frontdoor style outbound (*.msg) there are utilities that can be run to convert outbound files over to a filebox, thus making the
# outbox feature of binkd a lifesaver. A outbox for clarification sake, is a directory that is unique and pertinent to one link and one link only.
#
# Select between Sections A,B or C and edit accordingly. (Most will use Section A)
#
# [A] No filebox
#
# Uncomment and edit this example to show your session password, if you plan to poll for your mail change the c to a h.
#
#node 1:123/500@fidonet the-estar.com edit_me_for_your_password c 
#
# [B] Using a OUTBOX, No INBOX
#
# Uncomment and edit this example to show your session password, if you plan to poll for your mail change the c to a h.
#
#node 1:123/500@fidonet the-estar.com edit_me_for_your_password c c:\\mailer\\outbox
#
# [C] Using both a OUTBOX and a INBOX.
#
# Uncomment and edit this example to show your session password, if you plan to poll for your mail change the c to a h.
#
#node 1:123/500@fidonet the-estar.com edit_me_for_your_password c c:\\mailer\\outbox c:\\mailer\\inbox
#
# IMPORTANT NOTE: Passwords are case sensitive!!
#                 If you run under linux, path and filenames are case sensitive!!!