Welcome to a2d!

Congratulations on installing a2d portal. Let's guide you through the initial steps:


Register PIN and Passphrase:

Security is paramount in the a2d portal. Here's how to safeguard your access:

PIN Registration: Choose a personalized six-digit PIN. If this is your first time, select "Register" on the login page to set your 6-digit PIN and Passphrase.

Logging In: After registration, use your assigned PIN to log in. If there's no user activity, the login session will automatically expire in 20 min, ensuring the security of your data.

PIN Recovery: If you forget your PIN, utilize your Passphrase to create a new one. Click "Forgot PIN!" on the login page. Verify with your Passphrase. Upon successful verification, proceed to the page for setting a new PIN and Passphrase.


Dashboard Overview:

Navigation Bar: Links for navigating to Server, Mode (Light, Dark and Auto), and Options include Configuration, Advanced, Backup/Restore, Change PIN, Information, and Exit.

Dashboard: Displays Callsign, a2d Status, Run Interval, Last Run, Destination SSIDs, and Start<>Stop Relay buttons.

System Health: Displays CPU Temperature, Memory Usage, and CPU Load.

APRS to DAPNET Transmits: Shows logs of APRS to DAPNET transmitted messages.

a2d portal offers three screen modes with Bootstrap v5.3 support: light, dark, and auto.

Light: Provides a clean and bright interface for comfortable usage.
Dark: Offers a sleek, darker interface that's easy on the eyes, especially in low-light conditions.
Auto: Adapts to your local system settings, ensuring a seamless experience that aligns with your device's theme.

Choose the mode that suits your preferences and enhances your interaction with the a2d app.


Setup Configuration:

If it's your first time, the dashboard will show 'Setup Configuration' instead of your Callsign. Click "Configuration" in the Options dropdown to begin.

To complete setup:
1. Enter your HAM radio callsign in ALL CAPS without any SSID for Callsign (no ssid).
2. Input your APRS API Key from aprs.fi.
3. Provide your DAPNET account username and password.
4. Include your DAPNET transmitter group code. Each DAPNET transmitter belongs to a specific group. Find your code during transmitter configuration. You can find your transmitter group code when setting up your transmitter. If you're unsure, hampager.de provides support on finding your transmitter group.
5. Click "Set Config" to save.


Start<>Stop Relay:

After configuring, click "Start Relay" to begin and "Stop Relay" in the dashboard to halt. Once you stop the relay, a2d will not run even after system reboot.

The interval between each APRS to DAPNET transfer is managed by the crontab manager in your system. If the transfer interval is set to 15 min, cron will trigger the transfer at 0, 15, 30, and 45 min past the hour.

a2d is designed to transfer only APRS messages received after its first run, preventing flooding DAPNET with a large number of messages all at once.


Advanced Configuration:

If needed, modify in Advanced Options via Options in the navigation bar and selecting Advanced.

• Interval: Set retrieval frequency. Default is 15 minutes. Avoid very short intervals (below 5 min). Setting 0 (min) 0 (h) resets to 15 min (or) setting 1 (min) 0 (h) resets to 2 min.
• Preferred APRS SSIDs: Define target SSIDs for messages. -0 is your callsign without SSID. Find HAM APRS SSIDs on APRS SSID list.
• Transmit logs: Set displayed logs on dashboard.


Backup<>Restore Configuration:

Once you've set up your a2d configuration, you can use the backup/restore menu in the navigation bar to safeguard your settings. Both actions—backup and restore—require Passphrase verification.

Backup: Create a backup of your a2d configuration files. The backup file's name will be "a2d_config_backup.bin." This file is encoded binary and holds your API credentials. Store it securely.
Restore: If you want to revert to a previous configuration, use the backup file to restore. However, be cautious. If the bin file has been tampered with, the restore won't work, and using a modified bin file is strongly discouraged.

Errors while Backup<>Restore:

Invalid Passphrase: Retry with the correct Passphrase.
Configuration files missing: Set up Configuration.
Invalid file: During restore configuration, use the correct a2d_config_backup.bin file.
Configuration file tampered: If you spot this, avoid using the modified file as it could harm the a2d app.


Message Structure:

DAPNET paging messages are limited to 80 characters per message. To conserve space, a2d messages follow the structure below and will be delivered to your pager:

SourceCall (DestinationSSID): Message

SourceCall: The sender's callsign.
DestinationSSID: Your callsign's SSID.
Message: The message content.

Here, `NY3W` is the sender's callsign, `7` is the SSID of the receiver's (your) callsign (e.g., NY3W-7), and `Hello OM!` is the message.
If the DestinationSSID displays 0, it means the message is targeted for your callsign without any SSID.


Uninstallation:

Follow these steps to in your terminal to uninstall a2d from your system

For a thorough removal of user configuration files, it is advisable to uninstall the application after performing a Factory Reset in the a2d portal (Check Reset a2d section). This ensures a clean removal of user-specific settings.

  sudo apt purge a2d

However, please note that this command won't remove the core Nginx server and other dependencies that were installed alongside a2d. To completely remove all a2d dependencies, you can use the following commands:

Remove Nginx and its associated files:   sudo apt -y remove --purge nginx nginx-common nginx-full nginx-core
Remove Nginx configuration files:   sudo rm -rf /etc/nginx
Remove Nginx default configuration:   sudo rm -rf /etc/default/nginx
Remove Nginx init.d script:   sudo rm -rf /etc/init.d/nginx
Remove Nginx log files:   sudo rm -rf /var/log/nginx

Delete the Nginx user and group:

  sudo deluser nginx
  sudo delgroup nginx

Finally, perform an autoremove to clean up any remaining dependencies:

  sudo apt autoremove


Server Settings:

a2d offers server settings and advanced options for users who want to customize their server. Make changes cautiously. You can use a2d with its default settings for local access. If you want to access a2d from outside your network, you can do so by making careful adjustments to your router's firewall settings.


Server Page Overview:

Navigation Bar: Access to sections like Dashboard, Mode (Light, Dark, and Auto), Options, and Exit.
The Options section includes Server Configuration, Self-Signed SSL, CA Signed SSL, Change PIN, Reset Portal, Exit, and Information.

Server Status: Provides essential information, including the start time of Nginx and Gunicorn, Listen Port, Server Name, SSL Status, and SSL Certificate details such as Common Name (CN), Organization Name (O), and Expiry Date.

Network Health: Displays the Round Trip Time (RTT) to APRS and DAPNET servers, indicating the speed at which data can transfer between your system and their servers.

Server Configuration:

The server configuration allows you to modify a2d's default server settings. a2d's default settings include Listen Port: 9331, Server Name: _, and SSL disabled.

Desired Listen Port: You can choose the port number for a2d access. For standard HTTP, it's port 80, and for HTTPS, it's 443. Alternatively, you can select any other open port on your system. After changing the port, you'll need to access a2d using the specified port.

Desired Server Name: You can set the server name to match your desired domain name. Ensure that the server name corresponds to your domain name, especially if you've enabled SSL, as it should match the Common Name (CN) in the SSL certificate.

Choosing SSL Certificates: a2d offers the option to create and use either Self-Signed SSL or Certificate Authority (CA) SSL certificates for your convenience. The difference between them is the appearance of a green lock symbol in the browser when you access them. Ensure that your server name matches the CN in your certificate before making a choice. Before selecting an SSL option, you need to create the certificates.

Creating Self-Signed SSL Certificate: In a2d, you can create and store one self-signed SSL certificate. There's no limit to how many times you can create it. You can generate it through the Self Signed SSL link in the navigation bar or by clicking the green "Self Signed SSL" button inside Server Configuration. Self-Signed SSL certificates are not verified, so you'll encounter an SSL security warning when accessing a2d in a web browser. You'll need to bypass this warning to access a2d once Self-Signed SSL is enabled. Once you enabled SSL certificate access a2d through HTTPS.

Creating CA SSL Certificate: a2d offers the option to create CA SSL certificates directly through certbot and Let's Encrypt within the a2d portal. You can create them via the CA Signed SSL link in the navigation bar or by clicking the green "CA Signed SSL" button inside Server Configuration. You can generate as many CA Signed SSL certificates as needed. Ensure that the Common Name (CN) matches your domain name. Once you've created your desired SSL certificate, you can return to Server Configuration to set it for a2d. After certificate creation, a2d uses certbot for auto-renewal. If you no longer need CA SSL certificates, a2d provides an option to delete them by clicking "Delete CA SSL" in the CA Signed SSL and selecting the certificate to remove.


Firewall Settings:

Understanding your firewall settings is crucial. Carefully open the necessary ports on your router to achieve the following:

1. Access a2d from outside your network.
2. Generate CA SSL certificates. Let's Encrypt will use ports 80 and 443 to validate your server before issuing the certificate. If you have both IPv4 and IPv6, it's strongly recommended to open required ports for both IPv4 and IPv6. After generating certificates you can safely close them and leave 443 open if you want remove access to a2d outside of your network.

In case you are unable to open the ports for some reason and cannot generate Let's Encrypt certificates using the a2d portal, you can perform these tasks via the command line and adjust your DNS settings on your provider's website. For details vist the Certbot user guide


Resetting a2d portal:

a2d provides a Reset Portal option that allows you to reset the portal and delete SSL certificates, if desired. You need to enter correct Passphrase to reset the portal. You can choose to retain the SSL certificates during the factory reset. The Reset Portal option is available in the server page's Options. This action will delete all user files, configurations, and data. If you are accessing a2d via SSL during the reset, the server settings will revert to the default a2d settings, and you will need to access a2d through HTTP port 9331 after the reset.


Error Messages:

Error messages play a crucial role in guiding you through issues. They appear in two places:


1. Relay Status Container in the Dashboard:

If you encounter any of these errors, you'll see them next to "Status" in the Relay Status container. To resolve, ensure accurate information in your configuration and restart the relay.


• Invalid APRS API key • Incorrect APRS API key • Incorrect DAPNET username or password • Incorrect DAPNET callsign or txgroup


2. Error Messages Triggered by Click on the Dashboard:

For these errors, you'll see messages upon clicking. Solutions are provided below:

Invalid PIN: Retry with the correct PIN.
Invalid Passphrase: Retry with the correct Passphrase.
Configuration files missing: Set up Configuration.
Invalid file: During restore configuration, use the correct a2d_config_backup.bin file.
Configuration file tampered: If you spot this, avoid using the modified file as it could harm the a2d app.


3. Error Messages during Server Settings and SSL Certificates

Create Self-Signed SSL Certificate before Enabling: Ensure that you have created the required SSL certificates before configuring the server for SSL.
Server and Common Name Mismatch: Verify that your server name matches the Common Name (CN) of the certificate and corresponds to your domain name.
CA SSL Certificate Already Exists: Try deleting the CA SSL certificate before attempting to create a duplicate certificate.
CA SSL Does Not Exist: The SSL certificate you are trying to delete does not exist. Try refreshing the page.
Selected CA SSL or Server Name in Use: Do not delete an SSL certificate while it is in use. First, change the SSL settings in the server, and then attempt to delete it.
Unknown Response from the Server: This issue could be due to network problems, firewall blocking specific ports, or reaching Let's Encrypt's SSL certificate limits.
Failed to Update Server: Your server may be offline or unreachable.


Other Unknown Errors and Troubleshooting:

If new messages aren't reaching your DAPNET pager:

Database corruption may occur during message read/write interruptions, such as power outages, memory loss, or system failures.


License:

MIT License

Copyright (c) 2023 NGC2023

a2d/static/bootstrap/css/cdn_bootstrap_5-3_min.css
Copyright: 2011-2023 The Bootstrap Authors
License: MIT

a2d/static/bootstrap/js/cdn_bootstrap_5-3.js
Copyright: 2011-2023 The Bootstrap Authors
License: MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


License: CC-BY-3.0

a2d/static/bootstrap/css/bootstrap_docs_5-3.css
Copyright: 2011-2023 The Bootstrap Authors
License: CC-BY-3.0

a2d/static/bootstrap/js/bootstrap_5-3_mode.js
Copyright: 2011-2023 The Bootstrap Authors
License: CC-BY-3.0

We have made modifications to a portion of the Bootstrap code to suit our project's requirements. These minor modifications enables the Color mode toggler from Bootstrap's docs to work with a2d. Licensed under the Creative Commons Attribution 3.0 Unported License. For details, see https://creativecommons.org/licenses/by/3.0/.