-
Notifications
You must be signed in to change notification settings - Fork 0
[WIP] Fix download link in README and add installation examples #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…xed download links Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
Co-authored-by: RusEu <11183790+RusEu@users.noreply.github.com>
There was a problem hiding this 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/downloadlinks with versioned release URLs (usingv1.0.0as 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` |
Copilot
AI
Dec 17, 2025
There was a problem hiding this comment.
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.
| <array> | ||
| <string>/usr/local/bin/server-admin-bot</string> | ||
| <string>-config</string> | ||
| <string>/etc/server-admin-bot/config.yaml</string> |
Copilot
AI
Dec 17, 2025
There was a problem hiding this comment.
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.
| <string>/etc/server-admin-bot/config.yaml</string> | |
| <string>/Users/USERNAME/Library/Application Support/server-admin-bot/config.yaml</string> |
| Expand-Archive -Path server-admin-bot-windows-amd64.zip -DestinationPath . | ||
| # Run the executable | ||
| .\server-admin-bot-windows-amd64.exe -config config.yaml |
Copilot
AI
Dec 17, 2025
There was a problem hiding this comment.
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.
| # Install the service | ||
| .\nssm.exe install ServerAdminBot "C:\Path\To\server-admin-bot-windows-amd64.exe" "-config" "C:\Path\To\config.yaml" | ||
Copilot
AI
Dec 17, 2025
There was a problem hiding this comment.
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".
| # 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" |
Plan: Fix Download Link and Add Installation Instructions
Summary
✅ Successfully fixed the broken download link issue by replacing the non-functional
/latest/downloadURL with versioned release URLs✅ Added comprehensive installation instructions for all requested platforms:
✅ Added platform-specific service/daemon configuration instructions
✅ All code review feedback addressed
✅ Security check passed
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.