ARYNOX IP MONITOR
README / USER GUIDE / TERMS OF USE
Version: Included with application package
Owner: Arynox IT Service
Developer: Arynox Dev

Website:
https://arynox.com

================================================================================
1. OVERVIEW
================================================================================

Arynox IP Monitor is a Windows desktop application designed to monitor public IP
address changes, track VPN-related external routing differences, provide
heartbeat and alert notifications, maintain runtime and history logs, and offer
optional keep-alive functionality to help prevent idle session interruptions.

It is intended for users who need reliable visibility over:
- Actual external/public IP address
- Tunnel/VPN external/public IP address
- VPN active/inactive state
- Connectivity interruptions and recovery
- Ongoing monitor health through logs, status output, and email notifications

================================================================================
2. MAIN PURPOSE
================================================================================

Arynox IP Monitor helps users:
- Detect when the normal external/public IP changes
- Detect when a tunnel/VPN external/public IP changes
- Identify when a VPN appears to become active or inactive
- Track repeated lookup failures and detect outages
- Send recovery summaries after connectivity is restored
- Send startup, heartbeat, test, and change notification emails
- Save state, history, pending checks, and runtime information to files
- Maintain a clean desktop monitoring experience

================================================================================
3. KEY FEATURES
================================================================================

MONITORING
- Actual External IP monitoring
- Tunnel / VPN External IP monitoring
- VPN state detection
- Confirmation-based IP change handling to avoid false positives
- Outage tracking and recovery handling
- Runtime status tracking
- Manual force sync support

EMAIL NOTIFICATIONS
- Manual test email
- Startup email
- Heartbeat email
- IP change notification email
- Recovery summary email
- HTML email support
- Configurable SMTP settings
- Optional email enable/disable control
- Security mode selection for email transport

LOGGING AND STATE
- Text log file
- CSV log file
- History file
- Runtime status file
- Pending change state files
- Heartbeat marker file
- Current IP state files
- Log rotation support

KEEP ALIVE
- Optional keep-alive behavior
- Script-compatible anti-idle behavior using Shift + F15 style input logic

USER INTERFACE
- Dashboard tab with live status and control buttons
- Settings tab for general, email, monitor, and notification options
- Schedule tab for time-based control
- Help section
- Popup notifications
- Branded application interface

================================================================================
4. MAIN FUNCTIONS AND CONTROLS
================================================================================

DASHBOARD
The Dashboard gives a live overview of the application state, including:
- Current status
- Actual external IP
- Tunnel external IP
- VPN active state
- Monitoring controls
- Action controls
- Status/messages area

MONITOR CONTROLS
- Start
- Stop
- Pause
- Resume

ACTION CONTROLS
- Test Email
- Force Current IP Sync
- Reset Pending Change
- Open Log Folder

WHAT EACH ACTION DOES

Start
Starts the monitoring loop and begins active checking according to configured
settings.

Stop
Stops the monitor loop cleanly.

Pause
Temporarily pauses monitor activity without fully stopping the application.

Resume
Resumes monitoring after a pause.

Test Email
Sends a manual email test using the configured email settings.

Force Current IP Sync
Immediately refreshes and saves the current Actual and Tunnel external IP values
without waiting for the normal interval cycle.

Reset Pending Change
Clears pending IP change confirmation data.

Open Log Folder
Opens the folder containing operational files such as logs, state files, and
status outputs.

================================================================================
5. SETTINGS OVERVIEW
================================================================================

GENERAL SETTINGS
Typical General settings include:
- Base working folder
- Check interval seconds
- Enable/disable popup messages
- Enable/disable keep alive
- Popup timeout behavior

EMAIL SETTINGS
Typical Email settings include:
- Enable email notifications
- SMTP server
- SMTP port
- Username
- Password
- From address
- To recipients
- Security mode
- HTML email behavior
- Retry settings

MONITOR SETTINGS
Typical Monitor settings include:
- Actual external IP providers
- Tunnel external IP providers
- Change confirmation settings
- Outage threshold settings
- Heartbeat settings
- IP mode preferences

SCHEDULE SETTINGS
Typical Schedule settings include:
- Enable scheduled operation
- Start/stop windows
- Automatic start behavior
- Timing preferences

IMPORTANT NOTE
Saving Settings and Saving Schedule should confirm successful save completion to
the user.

================================================================================
6. EMAIL FUNCTIONALITY
================================================================================

The application can send several types of emails depending on configuration.

MANUAL TEST EMAIL
Sent when the user presses the Test Email button.

STARTUP EMAIL
Can be sent when the application starts, depending on configuration.

HEARTBEAT EMAIL
Sent periodically to confirm that the application is still running properly.

IP CHANGE EMAIL
Sent after a confirmed change in monitored external IP state.

RECOVERY EMAIL
Sent after connectivity or monitored lookup functionality recovers from an
outage condition.

EMAIL SECURITY
Depending on the target SMTP provider, the app may support or require:
- None
- STARTTLS / TLS
- SSL / TLS

Users must ensure the selected server, port, authentication method, and account
permissions are correct for their email provider or organizational mail system.

================================================================================
7. KEEP ALIVE FUNCTION
================================================================================

When enabled, Keep Alive helps reduce session idling by periodically sending an
anti-idle signal compatible with the original workflow design.

Purpose:
- Helps keep the workstation session active
- Helps reduce idle-triggered interruptions in some environments

Important:
- Keep Alive is not a guarantee against all screen lock, sleep, inactivity,
  security, or policy-based behaviors
- Corporate environments may still enforce security controls independently

================================================================================
8. WORKING FILES AND STORAGE
================================================================================

Operational files are typically stored in the configured base folder.

Default base folder:
C:\Arynox_IpMonitor

Typical files include:
- ExternalIP_Current.txt
- ExternalTunnelIP_Current.txt
- ExternalIP_ChangeLog.txt
- ExternalIP_ChangeLog.csv
- ExternalIP_History.txt
- ExternalIP_RuntimeStatus.txt
- ExternalIP_HeartbeatMarker.txt
- ExternalIP_PendingChange.txt
- ExternalTunnelIP_PendingChange.txt
- ExternalIP_Monitor.lock

Application settings and secure locally stored credential data may be stored
separately under the Windows user profile, depending on the build and current
configuration.

================================================================================
9. POPUP WINDOWS
================================================================================

Popup windows are used to notify the user of important events such as:
- Application start
- Save confirmations
- Email failures
- IP changes
- Recovery notices
- Other operational status messages

Behavior may depend on current settings and specific action type.

Important usability note:
Some confirmation popups, such as successful save confirmations, may be shown
even when general popup notifications are disabled, so the user knows the action
completed successfully.

================================================================================
10. INTENDED USE
================================================================================

Arynox IP Monitor is intended for legitimate monitoring, operational awareness,
and notification purposes.

Examples of appropriate use:
- Home office IP monitoring
- VPN path visibility
- Connectivity monitoring
- Technical environment tracking
- Alerting for network changes
- Administrative workstation awareness

Users are responsible for ensuring that their use of the application complies
with:
- Employer policies
- Local laws and regulations
- Network and security requirements
- Email provider and SMTP provider policies

================================================================================
11. LIMITATIONS
================================================================================

Arynox IP Monitor depends on external services and local system behavior.

Limitations may include:
- External IP providers may be unavailable or rate-limited
- Email delivery depends on correct SMTP configuration and provider acceptance
- VPN or routing environments may influence observed results
- Windows focus, popup, icon, and shell behavior may vary by system
- Keep Alive may not override sleep, lock, or policy enforcement
- Anti-virus, endpoint controls, or group policy may affect some behavior
- Microsoft 365, Gmail, and other services may require provider-specific auth
  methods and settings

================================================================================
12. TERMS OF USE
================================================================================

By using Arynox IP Monitor, you agree to the following:

1. The software is provided for lawful and authorized use only.
2. You are responsible for configuring it correctly for your environment.
3. You are responsible for protecting any account credentials you enter.
4. You are responsible for complying with employer, tenant, domain, and system
   policies.
5. You must not use the software in a way that violates law, policy, security
   obligations, or third-party service terms.
6. The developer and owner are not responsible for losses arising from:
   - misconfiguration
   - mail provider restrictions
   - network outages
   - third-party service failures
   - local operating system behavior
   - misuse of the software

This software is supplied on an "as is" basis without any guarantee of
merchantability or fitness for a particular purpose unless separately agreed in
writing by the owner/developer.

================================================================================
13. COPYRIGHT
================================================================================

Copyright (c) Arynox. All rights reserved.

This application, its branding, design elements, source materials, structure,
and related deliverables are protected by copyright and applicable intellectual
property laws.

No part of this application package may be copied, redistributed, modified,
rebranded, resold, sublicensed, or published without permission from the owner,
except where explicit written permission has been granted.

================================================================================
14. OWNER / DEVELOPER INFORMATION
================================================================================

Owner: Arynox
Developer: Arynox

Website:
https://arynox.com

================================================================================
15. QUICK START
================================================================================

1. Launch Arynox IP Monitor
2. Open Settings
3. Configure:
   - Base folder
   - Check interval
   - Popup behavior
   - Keep Alive preference
   - Email settings, if email notifications are required
4. Save Settings
5. Open Schedule if scheduling is needed
6. Save Schedule
7. Return to Dashboard
8. Press Start
9. Confirm monitoring status and outputs
10. Use Test Email if needed

================================================================================
16. DISTRIBUTION NOTE
================================================================================

This README file is intended to be included with distributed application
packages so end users understand:
- what the application does
- how it works
- what it stores
- who owns and develops it
- where to find the official website

================================================================================
END OF FILE
================================================================================
