From 1a788e0a402a410c8b54c64e521bb573b3317346 Mon Sep 17 00:00:00 2001 From: diogo464 Date: Tue, 14 Oct 2025 16:52:11 +0100 Subject: updated README --- README.md | 80 +++++---------------------------------------------------------- 1 file changed, 6 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 1467530..952e6d2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,6 @@ # Bonsai Web -A simple web interface for the Bonsai network latency graph generator. - -## Features - -- Clean, modern UI using Pico CSS -- YAML configuration input -- Real-time file generation -- File viewing and downloading capabilities -- Containerized deployment support +A simple web interface for the Bonsai. ## Local Development @@ -68,69 +60,24 @@ For development, the application includes fallback dummy data generation when `B ### Building the Container -#### Local Build (for testing) -```bash -./build.sh -``` - -#### Production Build and Push ```bash -PUSH=1 ./build.sh +just build +# or `just --set image build` ``` -The build script will: -- Always build the container image with appropriate tags -- Only push to `git.d464.sh/diogo464/bonsai-web` when `PUSH=1` is set -- Use git tags for versioning (or 'latest' if no tag) -- Check registry authentication only when pushing - -#### Manual Build Commands +#### Pushing the container ```bash -# Local build -podman build -t bonsai-web -f Containerfile . - -# Production build and push -podman build -t git.d464.sh/diogo464/bonsai-web:latest -f Containerfile . -podman push git.d464.sh/diogo464/bonsai-web:latest +just push +# or `just --set image push` ``` ### Running the Container -#### From Local Build -```bash -podman run -p 5000:5000 bonsai-web:local -``` - -#### From Registry ```bash podman run -p 5000:5000 git.d464.sh/diogo464/bonsai-web:latest ``` -### Registry Authentication - -Before pushing to the registry, authenticate with: -```bash -podman login git.d464.sh -``` - -### Bonsai Integration - -To integrate with the actual Bonsai tool, modify the `Containerfile` in the "BONSAI SETUP SECTION" to: - -1. Clone or copy the Bonsai source code to `/usr/src/bonsai` -2. Install Bonsai's dependencies -3. Ensure the Bonsai tool is properly configured - -Example: -```dockerfile -# In the BONSAI SETUP SECTION of Containerfile -RUN git clone https://github.com/your-org/bonsai.git /usr/src/bonsai -WORKDIR /usr/src/bonsai -RUN pip install -r requirements.txt -WORKDIR /app -``` - ## Usage 1. Open the web application in your browser @@ -167,18 +114,3 @@ Generates network files from a YAML configuration. "nodes.csv": "id,label,x,y\nnode1,Node 1,0,0\n..." } ``` - -## Project Structure - -``` -. -├── app.py # Flask backend -├── index.html # Main web page -├── script.js # Client-side JavaScript -├── logo.png # Bonsai logo -├── requirements.txt # Python dependencies -├── Containerfile # Container build instructions -├── build.sh # Container build script -├── .gitignore # Git ignore patterns -└── README.md # This file -``` \ No newline at end of file -- cgit