Merge pull request #12 from IlliaStrelsov/main

Add configurable --port for Web UI and update docs

Author: sirbonneville

README.md

@@ -112,7 +112,15 @@ If you see lines like the above, it means Docker is not running, or you do not h
 
 ## Bind for 0.0.0.0:3000 failed: port is already allocated
 
-This occurs when there is already a Docker container running that uses port 3000. If you're running RL Swarm on the same machine, you will have to stop RL Swarm to use CodeAssist.
+This occurs when there is already a Docker container running that uses port 3000.
+You have two options:
+1.  Stop the other service that is using the port (e.g., if you are running RL Swarm).
+2.  Run CodeAssist on a different port using the `--port` argument:
+
+```bash
+  uv run run.py --port 3001
+```
+> **Note:** When choosing a new port, please avoid `8000`, `8080`, `8001`, `8008`, `3003`, and `11434`, as they are reserved for other CodeAssist services.
 
 # Contributing
 

run.py

@@ -80,6 +80,7 @@ class Config:
     training_config_path: str
     no_sc: bool
     train_only: bool
+    port: int
 
 
 def detect_docker():
@@ -315,7 +316,7 @@ def setup_web_ui(config: Config) -> docker.models.containers.Container:
         auto_remove=False,
         name="codeassist-web-ui",
         ports={
-            "3000/tcp": 3000,  # Expose Web UI port
+            "3000/tcp": config.port,  # Expose Web UI port
         },
         volumes={
             f"{os.getcwd()}/persistent-data": {
@@ -1068,10 +1069,11 @@ def main(config: Config):
     CONSOLE.print(Markdown("# CodeAssist Started"), style=HEADER_COLOR)
 
     if not config.train_only:
-        browser.open("http://localhost:3000")
+        url = f"http://localhost:{config.port}"
+        browser.open(url)
 
         CONSOLE.print(
-            "A browser should have opened to http://localhost:3000. You can now start coding!",
+            f"A browser should have opened to {url}. You can now start coding!",
             style=INFO_COLOR,
         )
 
@@ -1203,6 +1205,10 @@ def main(config: Config):
         "--no-sc", action="store_true", help="Disable smart contract calls"
     )
 
+    parser.add_argument(
+        "-p", "--port", type=int, help="Port to expose the Web UI on", default=3000,
+    )
+
     args = parser.parse_args()
 
     config = Config(**args.__dict__)