DXSpider Documentation Wiki - User contributions [en-gb]

DXSpider Registration Support System

2025-04-14T10:08:54Z

EA2CW: /* 📦 Required Perl Modules */

= DXSpider Registration Support System =

📡 '''DXSpider Registration Support System''' provides a user-friendly way for sysops to manage registration requests via '''email''' and/or '''Telegram''', with clear messages and configurable templates in '''Spanish and English''' (default).

== 📌 Purpose ==

This system adds simple tools to support '''registration and password management''' on a DXSpider node. It allows users to send a request, and sysops to authorize or deny it with minimal effort, while keeping a record of all registration requests and their acceptance or denial.
It is not allowed to send more than 10 messages per day per IP.

== ⚙️ Features ==

* Users send requests via a simple command: <code>msg_sysop</code>
* Sysops receive Telegram alerts and emails
* Sysops can approve (<code>auth_register</code>) or reject (<code>deny_reg</code>) registrations
* Sends multilingual confirmation/denial messages to users
* Configurable templates for email content (Spanish/English)

== 📥 Commands Usage ==

The system uses three main commands for managing user registrations:

=== msg_sysop ===
Used by the user to send a registration request.

<pre>
msg_sysop <user_call> REGISTER <user_email> <comments>
</pre>

Example:
<pre>
msg_sysop EA1ZZZ REGISTER ea1zzz@example.net I would like to join the cluster
</pre>

=== auth_register ===
Used by the sysop to approve and register the user.

<pre>
auth_reg <user_call>
</pre>

Example:
<pre>
auth_reg EA1ZZZ
</pre>

=== deny_register ===
Used by the sysop to reject a registration request.

<pre>
deny_reg <user_call>
</pre>

Example:
<pre>
deny_reg EA1ZZZ
</pre>

== 📢 How It Works: Full Example ==

=== REGISTRATION REQUEST (msg_sysop) ===

'''User input from Telnet:'''
<pre>
msg_sysop XX0ABC REGISTER xx0abc@domain.com Requesting access
</pre>

{| class="wikitable" style="width:100%"
|-
! style="width:50%; vertical-align:top;" | Response to user
! style="width:50%; vertical-align:top;" | To sysop via email
|-
|
<pre>
Message sent to sysop.
Call: XX0ABC
Subject: REGISTER
Email: xx0abc@domain.com
Message: Requesting access
</pre>
|
<pre>
Subject: Msg received from XX0ABC (REGISTER) to EA3CV-2

New message via msg_sysop command:

Node: EA3CV-2
Call: XX0ABC
Subject: REGISTER
Email: xx0abc@domain.com
IP: 1.2.3.4
Message: Requesting access
</pre>
|-
! style="vertical-align:top;" | To user via email
! style="vertical-align:top;" | To sysop via Telegram
|-
|
<pre>
Asunto: Msg del sysop de / Msg from sysop of EA3CV-2

En breve recibira una respuesta.
Saludos.

You will receive a response shortly.
Regards,

Kin EA3CV
</pre>
|
<pre>
📡 Message from DXSpider command:
Date: 13 April 2025 16:35:02
Call: XX0ABC
Subject: REGISTER
Email: xx0abc@domain.com
Sent by: EA3CV
IP: 1.2.3.4
Requesting access
</pre>
|}

'''Entry in pending_reg.txt:'''
<pre>
20250413-163500,00000000-000000,PENDING ,XX0ABC,u$2wGVX=,1.2.3.4,xx0abc@domain.com
</pre>

=== REGISTRATION APPROVAL (auth_register) ===

'''Sysop input from Console:'''
<pre>
auth_reg XX0ABC
</pre>

{| class="wikitable" style="width:100%"
|-
! style="width:50%; vertical-align:top;" | Sysop output
! style="width:50%; vertical-align:top;" | To user via email
|-
|
<pre>
Registration completed for XX0ABC
Email: joaquin@cronux.net
IP: 127.0.0.1
Pass: u$2wGVX=
</pre>
|
<pre>
Asunto: Aceptada su solicitud de registro / Registration accepted XX0ABC at EA3CV-2

Se ha aceptado su solicitud de registro

Usuario: XX0ABC
Password: u$2wGVX=

Use el comando `set/password` para cambiar la contraseña si lo desea.
Disfrute.

Your registration request has been approved.

User: XX0ABC
Password: u$2wGVX=

You can use the `set/password` command to change your password if you wish.
Enjoy.

Kin EA3CV
</pre>
|}

'''Entry in pending_reg.txt:'''
<pre>
20250413-163500,20250413-164558,ACCEPTED,XX0ABC,u$2wGVX=,1.2.3.4,xx0abc@domain.com
</pre>

=== REGISTRATION DENIAL (deny_register) ===

'''Sysop input from Console:'''
<pre>
deny_reg XX0ABC
</pre>

{| class="wikitable" style="width:100%"
|-
! style="width:50%; vertical-align:top;" | Sysop output
! style="width:50%; vertical-align:top;" | To user via email
|-
|
<pre>
Registration denied for XX0ABC
Email: joaquin@cronux.net
IP: 127.0.0.1
</pre>
|
<pre>
Asunto: Denegada su solicitud de registro / Registration denied XX0ABC at EA3CV-2

Se ha denegado su solicitud de registro.

Si cree que esto es un error, puede contactar con el administrador.
Gracias.

Your registration request has been denied.

If you believe this is a mistake, please contact the administrator.
Thank you.

Kin EA3CV
</pre>
|-
! colspan="2" style="vertical-align:top;" | To sysop via Telegram
|-
|
<pre>
❌ DENIED registration of XX0ABC from 127.0.0.1
</pre>
|}

'''Entry in pending_reg.txt:'''
<pre>
20250413-163500,20250413-165008,DENIED ,XX0ABC,u$2wGVX=,1.2.3.4,xx0abc@domain.com
</pre>

== 📂 Scripts Included ==

All scripts go in <code>/spider/local_cmd/</code>

* [https://github.com/EA3CV/dxspider_info/blob/main/msg_sysop.pl msg_sysop.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/auth_register.pl auth_register.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/deny_register.pl deny_register.pl]

Also required:

* [https://github.com/EA3CV/dxspider_info/blob/main/Local.pm Local.pm] → to <code>/spider/local/Local.pm</code>

== 🧩 Configuration: DXVars.pm ==

Append to <code>/spider/local/DXVars.pm</code>:

<syntaxhighlight lang="perl">
# Telegram config
$id = "123456789";
$token = "123456789:ABCDEF-TOKEN";

# Email SMTP config
$email_enable = 1;
$email_from = 'you@example.com';
$email_smtp = 'smtp.example.com';
$email_port = 587; # Port 587 for STARTTLS/Port 465 for SSL)
$email_user = 'your_user';
$email_pass = 'your_pass';
</syntaxhighlight>

== 📑 Files Used ==

* <code>/spider/local_data/pending_reg.txt</code> — Automatically created
* <code>/spider/local_cmd/*.pl</code> — Command scripts
* <code>/spider/local/Local.pm</code> — Email & Telegram logic
* <code>/spider/local/DXvars.pm</code> — Email and Telegram variables

== 🔧 Installation ==

# Copy the scripts to <code>/spider/local_cmd/</code>
# Edit <code>/spider/local/DXVars.pm</code> with your email and Telegram settings
# Install required Perl modules (see below)
# Restart the DXSpider node

== 📦 Required Perl Modules ==

Install with CPAN (from Linux shell):

<syntaxhighlight lang="bash">
cpan Net::SMTP
cpan Net::SMTP::SSL
cpan Net::MQTT::Simple
cpan List:Util
</syntaxhighlight>

== ✏️ Template Customization ==

Each script includes variables where you can '''modify the bilingual message content'''. Look for blocks like:

<syntaxhighlight lang="perl">
my $msg_text_ok = <<"EMAIL";
...
EMAIL
</syntaxhighlight>

== ✅ Commands Summary ==

{| class="wikitable"
! Command !! Description
|-
| <code>msg_sysop</code> || User sends registration request
|-
| <code>auth_register</code> || Sysop approves and registers the user
|-
| <code>deny_reg</code> || Sysop denies the request
|}

== 👤 Author ==

'''Kin EA3CV''' — [mailto:ea3cv@cronux.net ea3cv@cronux.net] April 2025

DXSpider Registration Support System

2025-04-11T20:03:31Z

EA2CW: /* 📑 Files Used */

= DXSpider Registration Support System =

📡 '''DXSpider Registration Support System''' provides a user-friendly way for sysops to manage registration requests via '''email''' and/or '''Telegram''', with clear messages and configurable templates in '''Spanish and English'''.

== 📌 Purpose ==

This system adds simple tools to support '''registration and password management''' on a DXSpider node. It allows users to send a request, and sysops to authorize or deny it with minimal effort.

== ⚙️ Features ==

* Users send requests via a simple command: <code>msg_sysop</code>
* Sysops receive Telegram alerts and emails
* Sysops can approve (<code>auth_register</code>) or reject (<code>deny_reg</code>) registrations
* Sends multilingual confirmation/denial messages to users
* Configurable templates for email content (Spanish/English)

== 💬 How It Works ==

1. '''User''' sends a message:
<pre>
msg_sysop EA0ABC-2 REGISTER name@domain.net Registration request</pre>

2. '''Sysop receives:'''
* 📧 Email with request details
* 📱 Telegram notification (optional)

3. '''Sysop approves:'''
<pre>
auth_register EA0ABC-2</pre>

4. '''User receives confirmation email''', e.g.:
<pre>
Subject: Registration accepted EA0ABC-2 at EA3CV-3
User: EA0ABC-2
Password: 5B54gqGz</pre>

5. '''Or sysop denies:'''
<pre>
deny_reg EA0ABC-2</pre>

6. '''User receives denial notice''', e.g.:
<pre>
Subject: Access request denied for EA0ABC-2 on EA3CV-3</pre>

== 📂 Scripts Included ==

All scripts go in <code>/spider/local_cmd/</code>

* [https://github.com/EA3CV/dxspider_info/blob/main/msg_sysop.pl msg_sysop.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/auth_register.pl auth_register.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/deny_register.pl deny_register.pl]

Also required:

* [https://github.com/EA3CV/dxspider_info/blob/main/Local.pm Local.pm] → to <code>/spider/local/Local.pm</code>

== 🧩 Configuration: DXVars.pm ==

Append to <code>/spider/local/DXVars.pm</code>:

<syntaxhighlight lang="perl">
# Telegram config
$id = "123456789";
$token = "123456789:ABCDEF-TOKEN";

# Email SMTP config
$email_enable = 1;
$email_from = 'you@example.com';
$email_smtp = 'smtp.example.com';
$email_port = 587; # Port 587 for STARTTLS/Port 465 for SSL)
$email_user = 'your_user';
$email_pass = 'your_pass';
</syntaxhighlight>

== 📑 Files Used ==

* <code>/spider/local_data/pending_reg.txt</code> — Automatically created
* <code>/spider/local_cmd/*.pl</code> — Command scripts
* <code>/spider/local/Local.pm</code> — Email & Telegram logic
* <code> /spider/local/DXvars.pm</code> — email and Telegram variables

== 🔧 Installation ==

# Copy the scripts to <code>/spider/local_cmd/</code>
# Edit <code>/spider/local/DXVars.pm</code> with your email and Telegram settings
# Install required Perl modules (see below)
# Restart the DXSpider node

== 📦 Required Perl Modules ==

Install with CPAN (from Linux shell):

<syntaxhighlight lang="bash">
cpan Net::SMTP
cpan Net::SMTP::SSL
cpan Net::MQTT::Simple
cpan JSON
</syntaxhighlight>

== ✏️ Template Customization ==

Each script includes variables where you can '''modify the bilingual message content'''. Look for blocks like:

<syntaxhighlight lang="perl">
my $msg_text_ok = <<"EMAIL";
...
EMAIL</syntaxhighlight>

You can change these to fit your tone and language.

== 📧 Example Messages ==

=== Request Received ===
<pre>
Subject: Message received for EA3CV-3 sysop

En breve recibira una respuesta.
Saludos.

You will receive a response shortly.
Regards,

Kin EA3CV</pre>

=== Confirmation Message ===
<pre>
Subject: Registration accepted EA0ABC-2 at EA3CV-3

Se ha aceptado su solicitud de registro

Usuario: EA0ABC-2
Password: 5B54gqGz

Use el comando `set/password` para cambiar la contraseña si lo desea.
Disfrute.

Your registration request has been approved.

User: EA0ABC-2
Password: 5B54gqGz

You can use the `set/password` command to change your password if you wish.
Enjoy.

Kin EA3CV</pre>

=== Denial Message ===
<pre>
Subject: Access request denied for EA0ABC-2 on EA3CV-3

Lamentamos informarle que su solicitud de acceso para EA0ABC-2 ha sido denegada en EA3CV-3.

No cumple con los criterios requeridos.
Puede intentarlo más adelante si lo desea.

We regret to inform you that your access request for EA0ABC-2 has been denied on EA3CV-3.

It does not meet the required criteria.
You may try again later if you wish.

Kin EA3CV</pre>

=== Telegram Notifications ===

* Incoming request:
<pre>
📡 Message from DXSpider command:
Call: EA0ABC-2
Subject: REGISTER
Email: name@domain.net
Sent by: EA3CV
IP: 1.2.3.4</pre>

* Approval:
<pre>
✅ Registered EA0ABC-2 in EA3CV-3</pre>

* Denial:
<pre>
❌ Registration denied for EA0ABC-2 on EA3CV-3</pre>

== ✅ Commands Summary ==

{| class="wikitable"
! Command !! Description
|-
| <code>msg_sysop</code> || User sends registration request (and anothers)
|-
| <code>auth_register</code> || Sysop approves and registers the user
|-
| <code>deny_reg</code> || Sysop denies the request
|}

== 👤 Author ==
'''Kin EA3CV''' — [mailto:ea3cv@cronux.net ea3cv@cronux.net] April 2025

DXSpider Registration Support System

2025-04-11T20:02:58Z

EA2CW: /* 📑 Files Used */

= DXSpider Registration Support System =

📡 '''DXSpider Registration Support System''' provides a user-friendly way for sysops to manage registration requests via '''email''' and/or '''Telegram''', with clear messages and configurable templates in '''Spanish and English'''.

== 📌 Purpose ==

This system adds simple tools to support '''registration and password management''' on a DXSpider node. It allows users to send a request, and sysops to authorize or deny it with minimal effort.

== ⚙️ Features ==

* Users send requests via a simple command: <code>msg_sysop</code>
* Sysops receive Telegram alerts and emails
* Sysops can approve (<code>auth_register</code>) or reject (<code>deny_reg</code>) registrations
* Sends multilingual confirmation/denial messages to users
* Configurable templates for email content (Spanish/English)

== 💬 How It Works ==

1. '''User''' sends a message:
<pre>
msg_sysop EA0ABC-2 REGISTER name@domain.net Registration request</pre>

2. '''Sysop receives:'''
* 📧 Email with request details
* 📱 Telegram notification (optional)

3. '''Sysop approves:'''
<pre>
auth_register EA0ABC-2</pre>

4. '''User receives confirmation email''', e.g.:
<pre>
Subject: Registration accepted EA0ABC-2 at EA3CV-3
User: EA0ABC-2
Password: 5B54gqGz</pre>

5. '''Or sysop denies:'''
<pre>
deny_reg EA0ABC-2</pre>

6. '''User receives denial notice''', e.g.:
<pre>
Subject: Access request denied for EA0ABC-2 on EA3CV-3</pre>

== 📂 Scripts Included ==

All scripts go in <code>/spider/local_cmd/</code>

* [https://github.com/EA3CV/dxspider_info/blob/main/msg_sysop.pl msg_sysop.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/auth_register.pl auth_register.pl]
* [https://github.com/EA3CV/dxspider_info/blob/main/deny_register.pl deny_register.pl]

Also required:

* [https://github.com/EA3CV/dxspider_info/blob/main/Local.pm Local.pm] → to <code>/spider/local/Local.pm</code>

== 🧩 Configuration: DXVars.pm ==

Append to <code>/spider/local/DXVars.pm</code>:

<syntaxhighlight lang="perl">
# Telegram config
$id = "123456789";
$token = "123456789:ABCDEF-TOKEN";

# Email SMTP config
$email_enable = 1;
$email_from = 'you@example.com';
$email_smtp = 'smtp.example.com';
$email_port = 587; # Port 587 for STARTTLS/Port 465 for SSL)
$email_user = 'your_user';
$email_pass = 'your_pass';
</syntaxhighlight>

== 📑 Files Used ==

* <code>/spider/local_data/pending_reg.txt</code> — Automatically created
* <code>/spider/local_cmd/*.pl</code> — Command scripts
* <code>/spider/local/Local.pm</code> — Email & Telegram logic
* /spider/local/DXvars.pm - email and Telegram variables

== 🔧 Installation ==

# Copy the scripts to <code>/spider/local_cmd/</code>
# Edit <code>/spider/local/DXVars.pm</code> with your email and Telegram settings
# Install required Perl modules (see below)
# Restart the DXSpider node

== 📦 Required Perl Modules ==

Install with CPAN (from Linux shell):

<syntaxhighlight lang="bash">
cpan Net::SMTP
cpan Net::SMTP::SSL
cpan Net::MQTT::Simple
cpan JSON
</syntaxhighlight>

== ✏️ Template Customization ==

Each script includes variables where you can '''modify the bilingual message content'''. Look for blocks like:

<syntaxhighlight lang="perl">
my $msg_text_ok = <<"EMAIL";
...
EMAIL</syntaxhighlight>

You can change these to fit your tone and language.

== 📧 Example Messages ==

=== Request Received ===
<pre>
Subject: Message received for EA3CV-3 sysop

En breve recibira una respuesta.
Saludos.

You will receive a response shortly.
Regards,

Kin EA3CV</pre>

=== Confirmation Message ===
<pre>
Subject: Registration accepted EA0ABC-2 at EA3CV-3

Se ha aceptado su solicitud de registro

Usuario: EA0ABC-2
Password: 5B54gqGz

Use el comando `set/password` para cambiar la contraseña si lo desea.
Disfrute.

Your registration request has been approved.

User: EA0ABC-2
Password: 5B54gqGz

You can use the `set/password` command to change your password if you wish.
Enjoy.

Kin EA3CV</pre>

=== Denial Message ===
<pre>
Subject: Access request denied for EA0ABC-2 on EA3CV-3

Lamentamos informarle que su solicitud de acceso para EA0ABC-2 ha sido denegada en EA3CV-3.

No cumple con los criterios requeridos.
Puede intentarlo más adelante si lo desea.

We regret to inform you that your access request for EA0ABC-2 has been denied on EA3CV-3.

It does not meet the required criteria.
You may try again later if you wish.

Kin EA3CV</pre>

=== Telegram Notifications ===

* Incoming request:
<pre>
📡 Message from DXSpider command:
Call: EA0ABC-2
Subject: REGISTER
Email: name@domain.net
Sent by: EA3CV
IP: 1.2.3.4</pre>

* Approval:
<pre>
✅ Registered EA0ABC-2 in EA3CV-3</pre>

* Denial:
<pre>
❌ Registration denied for EA0ABC-2 on EA3CV-3</pre>

== ✅ Commands Summary ==

{| class="wikitable"
! Command !! Description
|-
| <code>msg_sysop</code> || User sends registration request (and anothers)
|-
| <code>auth_register</code> || Sysop approves and registers the user
|-
| <code>deny_reg</code> || Sysop denies the request
|}

== 👤 Author ==
'''Kin EA3CV''' — [mailto:ea3cv@cronux.net ea3cv@cronux.net] April 2025

Sending messages to the sysop via Telegram

2025-04-10T00:58:53Z

EA2CW: changed set/msg_sysop by msg_sysop

= 📡 Sending messages to the sysop via Telegram =

== 📋 Description ==
The `msg_sysop` command allows users connected to a DXSpider node to send a direct message to the sysop via Telegram.

It is useful for:

* Requesting registration on the node
* Reporting issues or failures
* Making general enquiries

The message includes the following data:

* User callsign
* Subject (e.g. REGISTER, PROBLEM, INFO)
* Email address
* Message text
* Access IP

== ▶️ Command usage ==
From the DXSpider shell:<pre>
msg_sysop <CALL> <SUBJECT> <EMAIL> <MESSAGE>
</pre>

=== Examples ===
<pre>
msg_sysop XX0ABC REGISTER xx0abc@example.com Requesting registration
msg_sysop XX0ABC PROBLEM xx0abc@example.com My password is not working
msg_sysop XX0ABC-1 INFO xx0abc@example.com Greetings from DM42
</pre>The user will receive a confirmation, and the sysop will receive the complete message via Telegram.

== ⚙️ Required configuration ==
To use the `msg_sysop` command, minimal setup is needed for the Telegram bot.

=== 📁 File: /spider/local/Local.pm ===
Add the following to the end of the file, just before the final `1;`:<pre>
sub telegram
{
my $payload = shift;

my $url = "https://api.telegram.org/bot$main::token/sendMessage";
`curl -s -X POST $url -d chat_id=$main::id -d text="$payload\n" -d parse_mode="Markdown"`;
}
</pre>If `/spider/local/Local.pm` does not exist, you can copy it from the base installation:<pre>
cp /spider/perl/Local.pm /spider/local/
</pre>

=== 📁 File: /spider/local/DXVars.pm ===
Add your bot credentials at the end of the file, just before `1;`:<pre>
# Telegram Bot
$id = "123456789";
$token = "89734237899:KF90V20M90MCQJA9Q0'91C,CCC'0944";
</pre>Restart the node to apply the changes:<pre>
shutdown
</pre>

== 💬 Notify unregistered users ==
To let users know that they need to register and can use the `msg_sysop` command, you can override the default DXSpider error message.

Edit `/spider/startup` and add the following lines:<pre>
set/var $DXM::msgs{en}{e28} = 'Sorry, you need to be registered (Use the msg_sysop command to request registration.)'
set/var $DXM::msgs{es}{e28} = 'Lo sentimos, necesitas estar registrado (Usa el comando msg_sysop para solicitar registrarte)'
</pre>

== 📢 Display a message in the MOTD ==
To remind users upon login, edit the file `/spider/local_data/motd_nor`:<pre>
+-----------------------------------------------------------------------------+
| If you wish to have full access, please use the command 'msg_sysop' |
| to request registration on this node. |
+-----------------------------------------------------------------------------+
</pre>

== 📦 Script download ==
You can download the `msg_sysop.pl` script from the official repository:

[https://github.com/EA3CV/dxspider_info/blob/main/msg_sysop.pl View on GitHub - EA3CV/dxspider_info]

Save it as:<pre>
/spider/local_cmd/msg_sysop.pl
</pre>It may be helpful to look at [https://wiki.dxcluster.org/wiki/Setting_up_the_EA3CV_contributions_repository]

== 🔐 How to get your Telegram ID and Token ==
To receive messages, you need to configure a Telegram bot:

# Open Telegram and search for <code>@BotFather</code>
# Start a new bot with: <code>/newbot</code> and follow the instructions
# BotFather will return a token like:
<pre>
1234567890:AAEjg0EjEMPLO_T0KEN4PRUEBA1234
</pre>

# Send any message to your bot via Telegram
# Then open this URL in your browser (replace with your actual token):
<pre>
https://api.telegram.org/bot<your_token>/getUpdates
</pre>You will see something like:<pre>
"chat":{"id":123456789,"first_name":"YourName",...}
</pre>That number is your **chat ID**. Use this ID and your token in `/spider/local/DXVars.pm`.

=== ⚠️ Important ===
This script **only works with Telegram bots**. It is not possible to send messages directly to personal accounts via the Telegram API.

== 🧠 Additional notes ==

* This command is designed as a lightweight and direct alternative to email.
* The sysop receives all relevant data, including the user’s IP and callsign.
* You may combine this with logging or other scripts for additional traceability.

== 🧑‍💻 Author ==

* Kin EA3CV* — [mailto:ea3cv@cronux.net](mailto:ea3cv@cronux.net)