Camel.toolkits.web deploy toolkit

Documentation Index

Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt

Use this file to discover all available pages before exploring further.

​

WebDeployToolkit

class WebDeployToolkit(BaseToolkit):

• Initialize new React projects
• Build React applications
• Deploy HTML content to local server
• Serve static websites locally

​

init

def __init__(
    self,
    timeout: Optional[float] = None,
    add_branding_tag: bool = True,
    logo_path: str = '../camel/misc/favicon.png',
    tag_text: str = 'Created by CAMEL',
    tag_url: str = 'https://github.com/camel-ai/camel',
    remote_server_ip: Optional[str] = None,
    remote_server_port: int = 8080
):

• timeout (Optional[float]): Command timeout in seconds. (default: :obj:None)
• add_branding_tag (bool): Whether to add brand tag to deployed pages. (default: :obj:True)
• logo_path (str): Path to custom logo file (SVG, PNG, JPG, ICO). (default: :obj:../camel/misc/favicon.png)
• tag_text (str): Text to display in the tag. (default: :obj:Created by CAMEL)
• tag_url (str): URL to open when tag is clicked. (default: :obj:https://github.com/camel-ai/camel)
• remote_server_ip (Optional[str]): Remote server IP for deployment. (default: :obj:None - use local deployment)
• remote_server_port (int): Remote server port. (default: :obj:8080)

​

_validate_ip_or_domain

def _validate_ip_or_domain(self, address: str):

​

_validate_port

def _validate_port(self, port: int):

​

_sanitize_text

def _sanitize_text(self, text: str):

​

_validate_url

def _validate_url(self, url: str):

​

_validate_subdirectory

def _validate_subdirectory(self, subdirectory: Optional[str]):

​

_is_port_available

def _is_port_available(self, port: int):

​

_load_server_registry

def _load_server_registry(self):

​

_save_server_registry

def _save_server_registry(self):

​

_is_process_running

def _is_process_running(self, pid: int):

​

_build_custom_url

def _build_custom_url(self, domain: str, subdirectory: Optional[str] = None):

• domain (str): Custom domain
• subdirectory (Optional[str]): Subdirectory path

​

_load_logo_as_data_uri

def _load_logo_as_data_uri(self, logo_path: str):

• logo_path (str): Path to the logo file

​

_get_default_logo

def _get_default_logo(self):

​

deploy_html_content

def deploy_html_content(
    self,
    html_content: Optional[str] = None,
    html_file_path: Optional[str] = None,
    file_name: str = 'index.html',
    port: int = 8000,
    domain: Optional[str] = None,
    subdirectory: Optional[str] = None
):

• html_content (Optional[str]): HTML content to deploy. Either this or html_file_path must be provided.
• html_file_path (Optional[str]): Path to HTML file to deploy. Either this or html_content must be provided.
• file_name (str): Name for the HTML file when using html_content. (default: :obj:index.html)
• port (int): Port to serve on. (default: :obj:8000) (default: 8000)
• domain (Optional[str]): Custom domain to access the content. (e.g., :obj:example.com)
• subdirectory (Optional[str]): Subdirectory path for multi-user deployment. (e.g., :obj:user123)

​

_deploy_to_remote_server

def _deploy_to_remote_server(
    self,
    html_content: str,
    subdirectory: Optional[str] = None,
    domain: Optional[str] = None
):

• html_content (str): HTML content to deploy
• subdirectory (Optional[str]): Subdirectory path for deployment
• domain (Optional[str]): Custom domain

​

_deploy_to_local_server

def _deploy_to_local_server(
    self,
    html_content: str,
    file_name: str,
    port: int,
    domain: Optional[str],
    subdirectory: Optional[str]
):

• html_content (str): HTML content to deploy
• file_name (str): Name for the HTML file
• port (int): Port to serve on (default: 8000) (default: 8000)
• domain (Optional[str]): Custom domain
• subdirectory (Optional[str]): Subdirectory path

​

_serve_static_files

def _serve_static_files(self, directory: str, port: int):

• directory (str): Directory to serve files from
• port (int): Port to serve on (default: 8000) (default: 8000)

​

deploy_folder

def deploy_folder(
    self,
    folder_path: str,
    port: int = 8000,
    domain: Optional[str] = None,
    subdirectory: Optional[str] = None
):

• folder_path (str): Path to the folder to deploy.
• port (int): Port to serve on. (default: :obj:8000) (default: 8000)
• domain (Optional[str]): Custom domain to access the content. (e.g., :obj:example.com)
• subdirectory (Optional[str]): Subdirectory path for multi-user deployment. (e.g., :obj:user123)

​

_deploy_folder_to_local_server

def _deploy_folder_to_local_server(
    self,
    folder_path: str,
    port: int,
    domain: Optional[str],
    subdirectory: Optional[str]
):

• folder_path (str): Path to the folder to deploy
• port (int): Port to serve on
• domain (Optional[str]): Custom domain
• subdirectory (Optional[str]): Subdirectory path

​

_deploy_folder_to_remote_server

def _deploy_folder_to_remote_server(
    self,
    folder_path: str,
    subdirectory: Optional[str] = None,
    domain: Optional[str] = None
):

• folder_path (str): Path to the folder to deploy
• subdirectory (Optional[str]): Subdirectory path for deployment
• domain (Optional[str]): Custom domain

​

stop_server

def stop_server(self, port: int):

• port (int): Port of the server to stop.

​

list_running_servers

def list_running_servers(self):

​

get_tools

def get_tools(self):