Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
module:install-xtrn [2021/02/13 11:47] – created mlongmodule:install-xtrn [2021/11/18 14:28] (current) – [Command Line Options] Use proper table markup digital man
Line 1: Line 1:
-====== Install-xtrn.js (Automated Install for External Programs) ====== +====== External Program Installer ======
-A utility used to aid in installing programs to the External Programs section.+
  
-This script parses a .ini file (default filename is install-xtrn.ini) and installs the external programs defined within into the Synchronet BBS 
-configuration file: ctrl/xtrn.cnf.  The programs defined within this file can by online programs (a.k.a. Doors), editors, or events. 
  
-If the door is included with Synchronet, or Synchronet already has a configuration for it (in xtrn/3rdp-install), you can use the install-xtrn.js script to install your door. For third party doors, you should extract the door files into your external directory first, and perform any required unpacking/installing of the files. Once the final executable file is in place, Synchronet can check for a file signature match and install the door configuration if it has a matching known configuration for it.+This script parses a ''.ini'' file (default filename is ''install-xtrn.ini'') and installs the external programs defined within into the Synchronet BBS configuration file: ''[[dir:ctrl]]/xtrn.cnf''. The programs defined within this file can by online programs (a.k.a. Doors), editors, or events. 
 + 
 +This script can by invoked in a more user-friendly automated fashion by running [[person:echicken]]'s [[module:xtrn-setup]] module. 
 + 
 +If the door is included with Synchronet, or Synchronet already has a configuration for it (in ''xtrn/3rdp-install''), you can use the ''install-xtrn.js'' script to install your door. For third party doors, you should extract the door files into your external directory first, and perform any required unpacking/installing of the files. Once the final executable file is in place, Synchronet can check for a file signature match and install the door configuration if it has a matching known configuration for it. 
  
 ===== Running the Script ==== ===== Running the Script ====
Line 24: Line 25:
  
 ^ Command ^ Description ^ ^ Command ^ Description ^
-^ -auto ^ Don't prompt for a list of doors to install ^ +| -auto | Don't prompt for a list of doors to install | 
-^ -debug ^ Shows what would happen (does not make changes) ^ +| -debug | Shows what would happen (does not make changes) | 
-^ -overwrite ^ Overwrite already-installed door ^+| -overwrite | Overwrite already-installed door |
  
 ===== Third Party External Programs (Doors) ===== ===== Third Party External Programs (Doors) =====
Line 41: Line 42:
   - Perform any required tasks according to the sysop documentation, such as resetting the program, etc.   - Perform any required tasks according to the sysop documentation, such as resetting the program, etc.
   - Apply any registration codes you have for the program   - Apply any registration codes you have for the program
 +
 +===== install_xtrn.ini =====
 +
 + This script is intended for use by sysops using JSexec, for example:
 +   $ jsexec install-xtrn ../xtrn/minesweeper
 +
 + This script can aso be invoked using the ;EXEC sysop command while logged
 + into the terminal server, for example:
 +   ;exec ?install-xtrn ../xtrn/minesweeper
 +
 + install-xtrn.js reads the directory specified  install-xtrn.ini (ie: ../xtrn/minesweeper/install-xtrn.ini
 +
 + The .ini root section keys supported:
 +
 + Name = Name of the program being installed (79 chars or less)\\
 + Desc = Description of the program being installed (79 chars or less)\\
 + By   = Comma-separated list of programmers/authors/publishers\\
 + Cats = Comma-separated list of applicable categories (e.g. "Games")\\
 + Subs = Comma-separated list of applicable sub-categories (e.g. "Adventure")\\
 + Inst = Installer .ini file source/revision/author/date information\\
 +
 + The .ini sections and keys supported (zero or more of each may be included):
 +
 + [pre-exec:<file>.js [args]] ; execute file.js before installing programs
 + startup_dir = directory to make current before execution
 +
 + [pre-eval:<js-expression>] ; evaluate js-expression before installing progs
 +      cmd             = evaluate this string rather than the js-expression
 +
 + [prog:<code>]
 +  name = program name or description (40 chars max)
 +      cats            = additional target installation categories (sections)
 + cmd = command-line to execute (63 chars max)
 + clean_cmd = clean-up command-line, if needed (63 chars max)
 + settings = bit-flags (see XTRN_* in sbbsdefs.js)
 + ars = access requirements string (40 chars max)
 + execution_ars = execution requirements string (40 chars max)
 + type = drop-file type (see XTRN_* in sbbsdefs.js)
 + event = event-type (see EVENT_* in sbbsdefs.j)
 + cost = cost to run, in credits
 + startup_dir = directory to make current before execution
 + textra = extra time (minutes) to allow to run this program
 + max_time = maximum time (minutes) allowed to run this program
 +
 + [event:<code>]
 + cmd = command-line to execute (63 chars max)
 + days = bit-field representing days of the week to execute
 + time = time of day to run this event
 + node_num = node number to run this event
 + settings = bit-flags (see XTRN_* in sbbsdefs.js)
 + startup_dir = directory to make current before execution
 + freq = frequency of execution
 + mdays = days of month (if non-zero) for execution
 + months = bit-field representing which months to execute
 +
 + [editor:<code>]
 + name = editor name or description (40 chars max)
 + cmd = command-line to execute (63 chars max)
 + type = drop-file type (see XTRN_* in sbbsdefs.js)
 + settings = bit-flags (see XTRN_* in sbbsdefs.js)
 + ars = access requirements string (40 chars max)
 +
 + [service:<protocol>]
 +      see ctrl/services.ini 
 +
 + [exec:<file>.js [args]] ; execute file.js with these arguments - after
 + startup_dir = directory to make current before execution
 +
 + [eval:<js-expression>] ; evaluate js-expression after installing programs
 +      cmd             = evaluate this string rather than the js-expression
 +
 + [ini:<filename.ini>[:section]]
 +      keys            = comma-separated list of keys to add/update in .ini
 +      values          = list of values to eval() and assign to keys[]
 +                        Note: string values must be enclosed in quotes!
 +
 + Additionally, each section can have the following optional keys that are
 + only used by this script (i.e. not written to any configuration files):
 + note = note to sysop displayed before installation
 + fail = note to sysop displayed upon failure
 +      prompt          = confirmation prompt (or false if no prompting)
 + required = if true, this item must be successful to continue
 +      last            = if true, this item will be the last of its type
 +      done            = if true, no more installer items will be processed
 +
 + Notes:
 +
 + - The startup_dir will default to the location of the .ini file if this
 +   key is not defined within the .ini file.
 +
 + - The only required values are the <code> (internal code, 8 chars max) and
 +   cmd; all other keys will have functional default values if not defined in
 +   the .ini file.
 +
 + ===== Example install-xtrn.ini =====
 +  
 +  Name: AlleyCat! BBS Game Server Games
 +  Desc: Available Programs for use with acgs rgate.js connector
 +  By:   mortifis @ alleycat bbs
 +  Cats: Games
 +  Subs: GAMES, SBBS DEMOS
 +  Inst: 2021/01/02
 +  
 +  [prog:V200G]
 +  name =Synchronet         2.00g
 +  startup_dir = 
 +  cmd=?rgate.js v200g
 +  execution_ars  = 
 +  settings = XTRN_ANSI | XTRN_SH | XTRN_MULTIUSER
 +  type = 
 +  
 +  [prog:V230C]
 +  name =Synchronet         2.30c
 +  startup_dir =
 +  cmd=?rgate.js v230c
 +  execution_ars  = 
 +  settings = XTRN_ANSI | XTRN_SH | XTRN_MULTIUSER
 +  type = 
 +  
 +  [prog:SBBS1A14]
 +  name =Synchronet         1a14
 +  startup_dir =
 +  cmd=?rgate.js sbbs1a14
 +  execution_ars  = 
 +  settings = XTRN_ANSI | XTRN_SH | XTRN_MULTIUSER
 +  type = 
 +  
 +  [prog:TW2G2]
 +  name = TW2002 Gergovia
 +  cmd = ?rgate.js tw2g2
 +  execution_ars  = NOT GUEST
 +  settings = XTRN_ANSI | XTRN_SH | XTRN_MULTIUSER
 +  type = XTRN_GAP
 +
 +  [prog:TW2G3]
 +  name = TW2002 Hoboistica
 +  cmd = ?rgate.js tw2g3
 +  execution_ars  = NOT GUEST
 +  settings = XTRN_ANSI | XTRN_SH | XTRN_MULTIUSER
 +  type = XTRN_GAP
 +
 +
 ===== See Also ===== ===== See Also =====
   * [[:util:index:|Utilities]]   * [[:util:index:|Utilities]]

Trace: