Skip to content

Add --public argument to webui.py and update README documentation #666

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

Open
wants to merge 0 commits into
base: main
Choose a base branch
from

Conversation

faisal-fida
Copy link

@faisal-fida faisal-fida commented Jul 28, 2025

Summary by cubic

Added a --public argument to webui.py to allow creating a public URL for remote access, and updated the README with usage instructions.

  • New Features
    • Added --public flag to enable public sharing of the WebUI.
    • Updated documentation with examples and option details.

@CLAassistant
Copy link

CLAassistant commented Jul 28, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

cubic analysis

No issues found across 2 files. Review in cubic

Copy link
Contributor

cubic-dev-ai bot commented Jul 28, 2025

📚 Feature History

This PR modifies 2 files (+12 -1 lines).

🔗 Related Pull Requests

PR Title Merged Author
#599 upgrade to bu==0.1.47 May 15, 2025 @vvincent1234
#583 Fix/docker May 10, 2025 @vvincent1234
#583 Fix/docker May 10, 2025 @vvincent1234

📊 Summary

The public access and sharing functionality in the WebUI launch system has evolved through several targeted changes to webui.py and supporting documentation. This area centers on how users can expose the WebUI for remote or public access, and how those options are surfaced and documented.

katiue originally implemented the core argument parsing and launch logic in webui.py, defaulting to local-only access and omitting public sharing options. Early versions required manual code edits or external tunneling for remote access, which was not documented in README.md. This limited usability for users needing to share the interface.

vincent's PR #583 (May 2025) focused on Docker and installation improvements, updating the README for clearer setup but did not address public access or sharing flags. The documentation changes clarified local usage and environment configuration, but public access remained an advanced, undocumented use case.

vvincent1234's PR #599 (May 2025) upgraded browser automation dependencies and refactored browser launch logic, but again did not introduce or document public sharing capabilities. The focus was on reliability and compatibility, leaving the exposure of the WebUI unchanged.

Throughout these iterations, the README and webui.py maintained a local-first approach, with no explicit support for generating public URLs or using Gradio's sharing features. The absence of a --public flag or equivalent meant users had to rely on workarounds for remote collaboration or demonstration.

This history is relevant because PR #666 (Jul 2025) by faisal-fida introduces the first explicit --public argument, directly enabling and documenting public URL sharing for the WebUI—a capability previously missing from both code and documentation.


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.

2 participants