Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Override LOCALIPADD with localhost in documentation generation #657

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 19, 2025
Merged

Override LOCALIPADD with localhost in documentation generation #657

merged 3 commits into from
Aug 19, 2025

Conversation

Copy link
Contributor

Copilot AI commented Aug 19, 2025 •
edited
Loading

When generating documentation using armbian-config --doc, URLs in the generated documentation currently show actual IP addresses (e.g., http://192.168.1.100:8080) which are not useful for documentation purposes.

This PR implements a minimal fix by overriding the LOCALIPADD variable with localhost when the --doc option is used, ensuring all generated URLs show localhost instead of environment-specific IP addresses.

Changes Made

File: bin/armbian-config

  • Added single line: [[ "$1" == "--doc" ]] && LOCALIPADD="localhost"
  • Positioned before config.runtime.sh is loaded to ensure URLs are generated with localhost

Technical Implementation

The fix works by detecting the --doc argument early in the execution flow and overriding LOCALIPADD before the runtime configuration loads. This ensures that when update_sub_submenu_data functions generate URLs, they use localhost instead of the actual system IP address.

Before/After Examples

Before:

--cmd DPL002 - Duplicati remove (http://10.1.0.193:8200)
--cmd POR002 - Portainer remove (http://10.1.0.193:9000)
--cmd SSH002 - Remove sandboxed SSH server (ssh://10.1.0.193:2222)

After:

--cmd DPL002 - Duplicati remove (http://localhost:8200)
--cmd POR002 - Portainer remove (http://localhost:9000)
--cmd SSH002 - Remove sandboxed SSH server (ssh://localhost:2222)

Testing

  • ✅ Documentation generation shows 43 localhost URLs, 0 real IP URLs
  • ✅ Regular functionality preserved (still shows 40 real IP URLs for actual operations)
  • ✅ No interference between documentation and operational modes
  • ✅ Build system and help functionality unaffected
  • ✅ CI/CD documentation workflow will now generate localhost URLs

This change is minimal, surgical, and only affects documentation generation while preserving all existing functionality.

Fixes #656.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copy link
Contributor Author

Copilot AI commented Aug 19, 2025

@Tearran 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

@github-actions github-actions bot added size/small PR with less then 50 lines 08 Milestone: Third quarter release labels Aug 19, 2025
Copilot AI changed the title [WIP] Override LOCALIPADD with localhost in documentation generation Override LOCALIPADD with localhost in documentation generation Aug 19, 2025
Copilot AI requested a review from Tearran August 19, 2025 04:29
Copilot finished work on behalf of Tearran August 19, 2025 04:29
Tearran
Tearran approved these changes Aug 19, 2025
View reviewed changes
Copy link
Member

@Tearran Tearran left a comment

Choose a reason for hiding this comment

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

A+ interpretation

@github-actions github-actions bot added size/medium PR with more then 50 and less then 250 lines size/small PR with less then 50 lines Documentation Documentation changes or additions and removed size/small PR with less then 50 lines labels Aug 19, 2025
@Tearran
Copy link
Member

Tearran commented Aug 19, 2025

#654 @igorpecovnik this should fix issue unnecessary ip changes in the document.md

Tearran
Tearran requested changes Aug 19, 2025
View reviewed changes
Copy link
Member

@Tearran Tearran left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I did note that the docs.armbian.com show "<your-ip>" while here we are using "localhost". perhaps we should conform to established convention ""

@Tearran Tearran marked this pull request as ready for review August 19, 2025 05:16
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Tearran Tearran requested a review from Copilot August 19, 2025 05:19
Copilot
Copilot AI reviewed Aug 19, 2025
View reviewed changes
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 overrides the LOCALIPADD variable with localhost when using the --doc flag to generate documentation, ensuring URLs in the generated documentation show localhost instead of environment-specific IP addresses.

  • Adds a single line to detect --doc argument and override LOCALIPADD variable
  • Updates all service URLs in documentation from specific IP addresses to localhost
  • Preserves operational functionality while making documentation IP-agnostic

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@igorpecovnik igorpecovnik merged commit c7fae7c into main Aug 19, 2025
1 check passed
@igorpecovnik igorpecovnik deleted the copilot/fix-656 branch August 19, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Tearran Tearran Tearran approved these changes

Copilot code review Copilot Copilot left review comments

@igorpecovnik igorpecovnik igorpecovnik approved these changes

Assignees

@Tearran Tearran

Copilot code review Copilot

Labels

08 Milestone: Third quarter release Documentation Documentation changes or additions size/medium PR with more then 50 and less then 250 lines size/small PR with less then 50 lines

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Override LOCALIPADD with localhost in documentation generation

3 participants

@Tearran @igorpecovnik