Scripts - Revision history

G0TRT: /* user_default */

2025-04-11T08:49:50Z

user_default

← Older revision		Revision as of 08:49, 11 April 2025
Line 63:		Line 63:
	#EOF		#EOF

	+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
	1814.0 DL3RBF/P 11-Apr-2025 0839Z SOTA activation DM/RP-001 <ON6ZQ>
	7190.0 EA2CCG/P 11-Apr-2025 0839Z POTA ES-0261 ES-0921 <EA7KOY>		+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
	14042.0 F5NLX/P 11-Apr-2025 0839Z FFF 1027 POTA FR-3758 WCA F-07<F5MGS>		1814.0 DL3RBF/P 11-Apr-2025 0839Z SOTA activation DM/RP-001 <ON6ZQ>
	18104.0 RC0AT 11-Apr-2025 0839Z www.TNXQSO.com <R1NA>		7190.0 EA2CCG/P 11-Apr-2025 0839Z POTA ES-0261 ES-0921 <EA7KOY>
	7048.2 VA3JPX 11-Apr-2025 0838Z <KA2G>		14042.0 F5NLX/P 11-Apr-2025 0839Z FFF 1027 POTA FR-3758 WCA F-07<F5MGS>
	-------------------------------------------------------------------------------		18104.0 RC0AT 11-Apr-2025 0839Z www.TNXQSO.com <R1NA>
	Callsigns connected to G0TRT-9		7048.2 VA3JPX 11-Apr-2025 0838Z <KA2G>
	G1ABC G0TRT G3XVL WI3W G0FOZ		-------------------------------------------------------------------------------
	-------------------------------------------------------------------------------		Callsigns connected to G0TRT-9
	Date Hour SFI A K Forecast Logger		G1ABC G0TRT G3XVL WI3W G0FOZ
	11-Apr-2025 06 153 17 3 No Storms -> No Storms <W0MU>		-------------------------------------------------------------------------------
	-------------------------------------------------------------------------------		Date Hour SFI A K Forecast Logger
	Date Hour SFI A K Exp.K R SA GMF Aurora Logger		11-Apr-2025 06 153 17 3 No Storms -> No Storms <W0MU>
	11-Apr-2025 08 153 22 3 3 112 eru act no <DK0WCY>		-------------------------------------------------------------------------------
	+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++		Date Hour SFI A K Exp.K R SA GMF Aurora Logger
	Nodes: 6/380 Users [Loc/Clr]: 5/4725 Max: 4/4725 - Uptime: 9h 59m 25s		11-Apr-2025 08 153 22 3 3 112 eru act no <DK0WCY>
			+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
			Nodes: 6/380 Users [Loc/Clr]: 5/4725 Max: 4/4725 - Uptime: 9h 59m 25s

G0TRT: /* user_default */

2025-04-11T08:49:24Z

user_default

← Older revision		Revision as of 08:49, 11 April 2025
Line 48:		Line 48:
	The user_default.issue file, when copied to user_default or a callsign, is used to deliver initial information to a user. The file below will show the relevant information at login:		The user_default.issue file, when copied to user_default or a callsign, is used to deliver initial information to a user. The file below will show the relevant information at login:

	#		#
	# standard user default script		# standard user default script
	#		#
	blank +		blank +
	sh/dx 5		sh/dx 5
	blank -		blank -
	sh/u		sh/u
	blank -		blank -
	sh/wwv 1		sh/wwv 1
	blank -		blank -
	sh/wcy 1		sh/wcy 1
	blank +		blank +
	#		#
	#EOF		#EOF

	+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++		+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

G0TRT: /* startup */

2025-04-11T08:49:05Z

startup

← Older revision		Revision as of 08:49, 11 April 2025
Line 5:		Line 5:
	===startup===		===startup===

	#		#
	#		#
	# lines starting with a # are ignored		# lines starting with a # are ignored
	#		#
	# set maximum no of spots allowed to 100		# set maximum no of spots allowed to 100
	set/var $Spot::maxspots = 100		set/var $Spot::maxspots = 100
	#		#
	# reject node adverts		# reject node adverts
	rej/ann node_default input info telnet,cluster,7000,7300,7373,8000,8888,9000,17300		rej/ann node_default input info telnet,cluster,7000,7300,7373,8000,8888,9000,17300
	#		#
	# reject D0 and D1 prefixes which aren't on the ITU list		# reject D0 and D1 prefixes which aren't on the ITU list
	rej/spot node_default input 2 call d0,d1		rej/spot node_default input 2 call d0,d1
	rej/spot node_default input 3 by d0,d1		rej/spot node_default input 3 by d0,d1
	#		#
	# set outbound spider connections with nodes you've paired with		# set outbound spider connections with nodes you've paired with
	set/spider g1abc-2		set/spider g1abc-2
	set/spider gb7abc-1		set/spider gb7abc-1
	#		#
	# make instant connections to nodes		# make instant connections to nodes
	connect g1abc-2		connect g1abc-2
	connect gb7abc-1		connect gb7abc-1
	#		#
	# make people register before they can send spots		# make people register before they can send spots
	# 1 is on, 0 is off		# 1 is on, 0 is off
	set/var $main::reqreg = 1		set/var $main::reqreg = 1
	#		#
	# make people use a password to login		# make people use a password to login
	# 1 is on, 0 is off		# 1 is on, 0 is off
	set/var $main::passwdreq = 0		set/var $main::passwdreq = 0
	#		#
	# set the node's external dynamic IP		# set the node's external dynamic IP
	set/external_ip		set/external_ip
	#		#
	# set the node and logging pc IPv4s		# set the node and logging pc IPv4s
	# gather ip address from your network and add them at the end using ,'192.168.1.144' for example		# gather ip address from your network and add them at the end using ,'192.168.1.144' for example
	set/var @main::localhost_names ('127.0.0.1', '::1', '192.168.1.123','192.168.1.134')		set/var @main::localhost_names ('127.0.0.1', '::1', '192.168.1.123','192.168.1.134')
	#		#
	#EOF		#EOF

	===user_default===		===user_default===

G0TRT at 08:48, 11 April 2025

2025-04-11T08:48:20Z

← Older revision		Revision as of 08:48, 11 April 2025
Line 1:		Line 1:
	==Scripts==		==Scripts==

	~~From 1~~.~~48 onwards it will become increasingly~~ possible to ~~control DXSpider's operation with scripts of various kinds~~.		The directory /spider/scripts is a place for scripts to be placed. The main script in this directory is called startup that can be used to make changes to the cluster from the default settings on startup. This script is executed immediately after all initialisation of the node is done but before any connections are possible. The other two files are startup.issue, which is a minimal file to use to build a startup and user_default.issue

	~~The directory /spider/scripts is where it all happens and is used for several things. Firstly it contains a file called~~ startup that can be used to call in any changes to the cluster from the default settings on startup. This script is executed immediately after all initialisation of the node is done but before any connections are possible. Examples of this include how many spots it is possible to get with the sh/dx command, whether you want registration/passwords to be permanently on etc. An example file is shown below and is included in the distribution as startup.issue.		===startup===

	#		#
	# ~~startup script example~~		#
	#		# lines starting with a # are ignored
	# set maximum no of spots allowed to 100		#
	# set/var $Spot::maxspots = 100		# set maximum no of spots allowed to 100
	#		set/var $Spot::maxspots = 100
	# ~~Set registration~~ on		#
	# set/var $main::reqreg = 1		# reject node adverts
	#		rej/ann node_default input info telnet,cluster,7000,7300,7373,8000,8888,9000,17300
	# ~~Set passwords~~ on		#
	# set/var $main::passwdreq = 1		# reject D0 and D1 prefixes which aren't on the ITU list
	#		rej/spot node_default input 2 call d0,d1
			rej/spot node_default input 3 by d0,d1
			#
			# set outbound spider connections with nodes you've paired with
			set/spider g1abc-2
			set/spider gb7abc-1
			#
			# make instant connections to nodes
			connect g1abc-2
			connect gb7abc-1
			#
			# make people register before they can send spots
			# 1 is on, 0 is off
			set/var $main::reqreg = 1
			#
			# make people use a password to login
			# 1 is on, 0 is off
			set/var $main::passwdreq = 0
			#
			# set the node's external dynamic IP
			set/external_ip
			#
			# set the node and logging pc IPv4s
			# gather ip address from your network and add them at the end using ,'192.168.1.144' for example
			set/var @main::localhost_names ('127.0.0.1', '::1', '192.168.1.123','192.168.1.134')
			#
			#EOF

	As usual, any text behind a # is treated as a comment and not read. To use this file, simply rename it from startup.issue to startup. In our example above there are three options. The first option is the amount of spots that a user can request with the sh/dx command. Normally the default is to give 10 spots unless the user specifies more. Without this line enabled, the maximum a user can request is 100 spots. Depending on your link quality you may wish to enable more or less by specifying the number.		===user_default===

	The ~~other 2 options are dealt with more fully in~~ the ~~security section.~~		The user_default.issue file, when copied to user_default or a callsign, is used to deliver initial information to a user. The file below will show the relevant information at login:

	Secondly, it is used to store the login scripts for users and nodes. Currently this can only be done by the sysop but it is envisaged that eventually users will be able to set their own. An example is included in the distibution but here is a further example.		#
			# standard user default script
			#
			blank +
			sh/dx 5
			blank -
			sh/u
			blank -
			sh/wwv 1
			blank -
			sh/wcy 1
			blank +
			#
			#EOF

	#		+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
	~~# G0FYD~~		1814.0 DL3RBF/P 11-Apr-2025 0839Z SOTA activation DM/RP-001 <ON6ZQ>
	#		7190.0 EA2CCG/P 11-Apr-2025 0839Z POTA ES-0261 ES-0921 <EA7KOY>
	~~blank +~~		14042.0 F5NLX/P 11-Apr-2025 0839Z FFF 1027 POTA FR-3758 WCA F-07<F5MGS>
	~~sh/wwv 3~~		18104.0 RC0AT 11-Apr-2025 0839Z www.TNXQSO.com <R1NA>
	~~blank +~~		7048.2 VA3JPX 11-Apr-2025 0838Z <KA2G>
	~~sh/dx~~		-------------------------------------------------------------------------------
	~~blank +~~		Callsigns connected to G0TRT-9
	~~t g0jhc You abt?~~		G1ABC G0TRT G3XVL WI3W G0FOZ
	~~blank +~~		-------------------------------------------------------------------------------
			Date Hour SFI A K Forecast Logger
	~~The lines in between commands can simply insert a blank line or a character such as a + sign to make the output easier to read.~~ ~~Simply create this script with your favourite editor and save it with the callsign of the user as the filename. Filenames should always be in lower case.~~		11-Apr-2025 06 153 17 3 No Storms -> No Storms <W0MU>
			-------------------------------------------------------------------------------
	~~Commands can be inserted in the same way for nodes.~~ A ~~node may wish a series of commands to be issued on login, such as a merge command for example~~.		Date Hour SFI A K Exp.K R SA GMF Aurora Logger
			11-Apr-2025 08 153 22 3 3 112 eru act no <DK0WCY>
	~~Thirdly, there are 2 default scripts for users and nodes who do not have a specifically defined script.~~ ~~These are user_default and node_default~~		+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
			Nodes: 6/380 Users [Loc/Clr]: 5/4725 Max: 4/4725 - Uptime: 9h 59m 25s

Dxcadmin: 1 revision imported

2025-02-08T09:20:27Z

1 revision imported

← Older revision		Revision as of 09:20, 8 February 2025
(No difference)

DXSpider Documentation>G0vgs: Created page with "==Scripts== From 1.48 onwards it will become increasingly possible to control DXSpider's operation with scripts of various kinds. The directory /spider/scripts is where it all happens and is used for several things. Firstly it contains a file called startup that can be used to call in any changes to the cluster from the default settings on startup. This script is executed immediately after all initialisation of the node is done but before any connections are possible..."

2023-02-01T08:16:47Z

Created page with "==Scripts== From 1.48 onwards it will become increasingly possible to control DXSpider's operation with scripts of various kinds. The directory /spider/scripts is where it all happens and is used for several things. Firstly it contains a file called startup that can be used to call in any changes to the cluster from the default settings on startup. This script is executed immediately after all initialisation of the node is done but before any connections are possible..."

New page

==Scripts==

From 1.48 onwards it will become increasingly possible to control DXSpider's operation with scripts of various kinds.

The directory /spider/scripts is where it all happens and is used for several things. Firstly it contains a file called startup that can be used to call in any changes to the cluster from the default settings on startup. This script is executed immediately after all initialisation of the node is done but before any connections are possible. Examples of this include how many spots it is possible to get with the sh/dx command, whether you want registration/passwords to be permanently on etc. An example file is shown below and is included in the distribution as startup.issue.

#
# startup script example
#
# set maximum no of spots allowed to 100
# set/var $Spot::maxspots = 100
#
# Set registration on
# set/var $main::reqreg = 1
#
# Set passwords on
# set/var $main::passwdreq = 1
#

As usual, any text behind a # is treated as a comment and not read. To use this file, simply rename it from startup.issue to startup. In our example above there are three options. The first option is the amount of spots that a user can request with the sh/dx command. Normally the default is to give 10 spots unless the user specifies more. Without this line enabled, the maximum a user can request is 100 spots. Depending on your link quality you may wish to enable more or less by specifying the number.

The other 2 options are dealt with more fully in the security section.

Secondly, it is used to store the login scripts for users and nodes. Currently this can only be done by the sysop but it is envisaged that eventually users will be able to set their own. An example is included in the distibution but here is a further example.

#
# G0FYD
#
blank +
sh/wwv 3
blank +
sh/dx
blank +
t g0jhc You abt?
blank +

The lines in between commands can simply insert a blank line or a character such as a + sign to make the output easier to read. Simply create this script with your favourite editor and save it with the callsign of the user as the filename. Filenames should always be in lower case.

Commands can be inserted in the same way for nodes. A node may wish a series of commands to be issued on login, such as a merge command for example.

Thirdly, there are 2 default scripts for users and nodes who do not have a specifically defined script. These are user_default and node_default