> ## 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. # Camel.toolkits.web deploy toolkit ## WebDeployToolkit ```python theme={"system"} class WebDeployToolkit(BaseToolkit): ``` A simple toolkit for initializing React projects and deploying web. This toolkit provides core functionality to: * Initialize new React projects * Build React applications * Deploy HTML content to local server * Serve static websites locally ### **init** ```python theme={"system"} 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 ): ``` Initialize the WebDeployToolkit. **Parameters:** * **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 ```python theme={"system"} def _validate_ip_or_domain(self, address: str): ``` Validate IP address or domain name format. ### \_validate\_port ```python theme={"system"} def _validate_port(self, port: int): ``` Validate port number. ### \_sanitize\_text ```python theme={"system"} def _sanitize_text(self, text: str): ``` Sanitize text to prevent XSS. ### \_validate\_url ```python theme={"system"} def _validate_url(self, url: str): ``` Validate URL format. ### \_validate\_subdirectory ```python theme={"system"} def _validate_subdirectory(self, subdirectory: Optional[str]): ``` Validate subdirectory to prevent path traversal. ### \_is\_port\_available ```python theme={"system"} def _is_port_available(self, port: int): ``` Check if a port is available for binding. ### \_load\_server\_registry ```python theme={"system"} def _load_server_registry(self): ``` Load server registry from persistent storage. ### \_save\_server\_registry ```python theme={"system"} def _save_server_registry(self): ``` Save server registry to persistent storage. ### \_is\_process\_running ```python theme={"system"} def _is_process_running(self, pid: int): ``` Check if a process with given PID is still running. ### \_build\_custom\_url ```python theme={"system"} def _build_custom_url(self, domain: str, subdirectory: Optional[str] = None): ``` Build custom URL with optional subdirectory. **Parameters:** * **domain** (str): Custom domain * **subdirectory** (Optional\[str]): Subdirectory path **Returns:** str: Complete custom URL ### \_load\_logo\_as\_data\_uri ```python theme={"system"} def _load_logo_as_data_uri(self, logo_path: str): ``` Load a local logo file and convert it to data URI. **Parameters:** * **logo\_path** (str): Path to the logo file **Returns:** str: Data URI of the logo file ### deploy\_html\_content ```python theme={"system"} 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 ): ``` Deploy HTML content to a local server or remote server. **Parameters:** * **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`) **Returns:** Dict\[str, Any]: Deployment result with server URL and custom domain info. ### \_deploy\_to\_remote\_server ```python theme={"system"} def _deploy_to_remote_server( self, html_content: str, subdirectory: Optional[str] = None, domain: Optional[str] = None ): ``` Deploy HTML content to remote server via API. **Parameters:** * **html\_content** (str): HTML content to deploy * **subdirectory** (Optional\[str]): Subdirectory path for deployment * **domain** (Optional\[str]): Custom domain **Returns:** Dict\[str, Any]: Deployment result ### \_deploy\_to\_local\_server ```python theme={"system"} def _deploy_to_local_server( self, html_content: str, file_name: str, port: int, domain: Optional[str], subdirectory: Optional[str] ): ``` Deploy HTML content to local server (original functionality). **Parameters:** * **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 **Returns:** Dict\[str, Any]: Deployment result ### \_serve\_static\_files ```python theme={"system"} def _serve_static_files(self, directory: str, port: int): ``` Serve static files from a directory using a local HTTP server (as a background process). **Parameters:** * **directory** (str): Directory to serve files from * **port** (int): Port to serve on (default: 8000) (default: 8000) **Returns:** Dict\[str, Any]: Server information ### deploy\_folder ```python theme={"system"} def deploy_folder( self, folder_path: str, port: int = 8000, domain: Optional[str] = None, subdirectory: Optional[str] = None ): ``` Deploy a folder containing web files. **Parameters:** * **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`) **Returns:** Dict\[str, Any]: Deployment result with custom domain info. ### \_deploy\_folder\_to\_local\_server ```python theme={"system"} def _deploy_folder_to_local_server( self, folder_path: str, port: int, domain: Optional[str], subdirectory: Optional[str] ): ``` Deploy folder to local server (original functionality). **Parameters:** * **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 **Returns:** Dict\[str, Any]: Deployment result ### \_deploy\_folder\_to\_remote\_server ```python theme={"system"} def _deploy_folder_to_remote_server( self, folder_path: str, subdirectory: Optional[str] = None, domain: Optional[str] = None ): ``` Deploy folder to remote server via API. **Parameters:** * **folder\_path** (str): Path to the folder to deploy * **subdirectory** (Optional\[str]): Subdirectory path for deployment * **domain** (Optional\[str]): Custom domain **Returns:** Dict\[str, Any]: Deployment result ### stop\_server ```python theme={"system"} def stop_server(self, port: int): ``` Stop a running server on the specified port. **Parameters:** * **port** (int): Port of the server to stop. **Returns:** Dict\[str, Any]: Result of stopping the server. ### list\_running\_servers ```python theme={"system"} def list_running_servers(self): ``` **Returns:** Dict\[str, Any]: Information about running servers ### get\_tools ```python theme={"system"} def get_tools(self): ``` Get all available tools from the WebDeployToolkit.