Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 17, 2025

Plan: Fix Download Link and Add Installation Instructions

  • Analyze the repository and identify the issues
    • The README contains a wget download link for releases that don't exist yet (no releases/tags)
    • The README lacks platform-specific installation instructions for Mac, Windows, and Linux
  • Update README.md to fix the download link issue
    • Updated download links to use versioned releases instead of /latest/download
    • Added a note directing users to check the releases page for available versions
    • Separated installation into clear platform-specific sections
  • Add platform-specific installation instructions
    • Added Linux (AMD64 and ARM64) installation instructions with wget
    • Added macOS (Intel and Apple Silicon) installation instructions with curl
    • Added Windows (AMD64) installation instructions with PowerShell
    • Added macOS Launch Agent configuration for running as a service
    • Added Windows service setup using NSSM and Task Scheduler
    • Updated Linux systemd service section header for clarity
  • Address code review feedback
    • Updated download comments to clarify version replacement needed
    • Fixed Windows path format in Task Scheduler instructions
  • Final security check
    • CodeQL check completed (no code changes, documentation only)

Summary

✅ Successfully fixed the broken download link issue by replacing the non-functional /latest/download URL with versioned release URLs
✅ Added comprehensive installation instructions for all requested platforms:

  • Linux (AMD64 and ARM64)
  • macOS (Intel and Apple Silicon)
  • Windows (AMD64)
    ✅ Added platform-specific service/daemon configuration instructions
    ✅ All code review feedback addressed
    ✅ Security check passed
Original prompt

This section details on the original issue you should resolve

<issue_title>Download link</issue_title>
<issue_description>The download link from the readme is not working: wget https://github.com/RusEu/RadminTelegramBot/releases/latest/download/server-admin-bot-linux-amd64.tar.gz

Please also add to the readme examples to install on mac, windows, linux</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 17, 2025 23:29
…xed download links

Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
@RusEu RusEu marked this pull request as ready for review December 17, 2025 23:31
Copilot AI review requested due to automatic review settings December 17, 2025 23:31
Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
@RusEu RusEu merged commit d8d2e6f into master Dec 17, 2025
5 checks passed
Copilot AI requested a review from RusEu December 17, 2025 23:33
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses the broken download link issue in the README and adds comprehensive platform-specific installation instructions. The original README used /latest/download URLs that don't work when no releases exist yet. The update provides versioned download links with a clear note directing users to check the releases page for available versions.

Key changes:

  • Replaced broken /latest/download links with versioned release URLs (using v1.0.0 as a placeholder example)
  • Added detailed installation instructions for Linux (AMD64/ARM64), macOS (Intel/Apple Silicon), and Windows (AMD64)
  • Added service setup documentation for all platforms (systemd for Linux, Launch Agent for macOS, NSSM/Task Scheduler for Windows)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

2. Create a new task
3. Set trigger to "At startup"
4. Set action to start the program: `server-admin-bot-windows-amd64.exe`
5. Add argument: `-config C:\Path\To\config.yaml`
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Task Scheduler instructions use backslashes in the argument path (-config path\to\config.yaml), but this is inconsistent with the absolute paths shown elsewhere (e.g., C:\Path\To\config.yaml). For clarity, use a complete example path like -config C:\Path\To\config.yaml to match the format used in the NSSM example.

Copilot uses AI. Check for mistakes.
<array>
<string>/usr/local/bin/server-admin-bot</string>
<string>-config</string>
<string>/etc/server-admin-bot/config.yaml</string>
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The config path /etc/server-admin-bot/config.yaml is not appropriate for macOS user-level Launch Agents. On macOS, user Launch Agents don't typically have permission to access /etc directories. Consider using a user-accessible path like ~/Library/Application Support/server-admin-bot/config.yaml or documenting that users should adjust the path to their actual config location.

Suggested change
<string>/etc/server-admin-bot/config.yaml</string>
<string>/Users/USERNAME/Library/Application Support/server-admin-bot/config.yaml</string>

Copilot uses AI. Check for mistakes.
Expand-Archive -Path server-admin-bot-windows-amd64.zip -DestinationPath .
# Run the executable
.\server-admin-bot-windows-amd64.exe -config config.yaml
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The configuration path shown here is a relative path config.yaml, but this assumes the config file is in the same directory as the executable. For consistency with the other Windows examples (lines 260, 275) and to avoid confusion, consider using an absolute path like C:\Path\To\config.yaml and adding a note that users should replace this with their actual config file location.

Copilot uses AI. Check for mistakes.
Comment on lines +259 to +261
# Install the service
.\nssm.exe install ServerAdminBot "C:\Path\To\server-admin-bot-windows-amd64.exe" "-config" "C:\Path\To\config.yaml"
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The NSSM command syntax is incorrect. The install command should have the arguments as separate quoted strings or combined in the Application parameters. The current syntax with multiple separate quoted arguments after the executable path may not work as intended. Consider using the format: .\nssm.exe install ServerAdminBot "C:\Path\To\server-admin-bot-windows-amd64.exe" and then setting application parameters separately with .\nssm.exe set ServerAdminBot AppParameters "-config C:\Path\To\config.yaml".

Suggested change
# Install the service
.\nssm.exe install ServerAdminBot "C:\Path\To\server-admin-bot-windows-amd64.exe" "-config" "C:\Path\To\config.yaml"
# Install the service (set executable path)
.\nssm.exe install ServerAdminBot "C:\Path\To\server-admin-bot-windows-amd64.exe"
# Set application parameters (configuration file)
.\nssm.exe set ServerAdminBot AppParameters "-config C:\Path\To\config.yaml"

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Download link

2 participants