From 33e29cd1b8eddb2a54d6c2b98e6c5260aaa4b10f Mon Sep 17 00:00:00 2001 From: Natalia Rybchenko Date: Wed, 15 Oct 2025 11:34:54 +0300 Subject: [PATCH 1/3] deploy: rename initial deployment script for clarity Signed-off-by: Natalia Rybchenko --- scripts/{init_dev_host.sh => init_deploy.sh} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename scripts/{init_dev_host.sh => init_deploy.sh} (100%) diff --git a/scripts/init_dev_host.sh b/scripts/init_deploy.sh similarity index 100% rename from scripts/init_dev_host.sh rename to scripts/init_deploy.sh From 795fc4127e2d8e64b2dc6f9215361cc937b67dcc Mon Sep 17 00:00:00 2001 From: Natalia Rybchenko Date: Wed, 15 Oct 2025 00:35:53 +0300 Subject: [PATCH 2/3] readme: update formatting and structure for better clarity Improve README structure and readability by adjusting heading levels, reorganizing sections, refining wording, and adding missing links. Signed-off-by: Natalia Rybchenko --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e71b894b4..cceabb41f 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,20 @@ **Configurable Web Application to analyse TE results.** -Full documentation for the project is available at <>. +## Examples -# Overview -# Requirements +Demo is available [here](https://ts-factory.io/bublik/). -- **Debian 12 or 13, or Ubuntu 22.04 or 24.04** -- **Python 3.10 or 3.11 or 3.12 or 3.13** +## Documentation -# Installation +Full documentation is available [here](https://ts-factory.github.io/bublik-release/). + +## Requirements + +- Debian 12 or 13, or Ubuntu 22.04 or 24.04 +- Python 3.10 or 3.11 or 3.12 or 3.13 + +## Installation 1. Clone [bublik backend](https://github.com/ts-factory/bublik.git) to /opt/bublik/**bublik**. 2. Clone [bublik frontend](https://github.com/ts-factory/bublik-ui.git) to /opt/bublik/**bublik-ui**. 3. Clone [site-specific configuration](https://github.com/ts-factory/ts-rigs-sample.git) to /opt/bublik/**ts-rigs**. @@ -24,6 +29,7 @@ Full documentation for the project is available at <>. ./scripts/deploy -c ol/selftest -H bublik-db -k /etc/bublik.keytab ``` 5. Check to NGINX settings in /etc/nginx/sites-available/bublik: + ``` location /v2/ { alias /opt/bublik/bublik-ui/dist/bublik/; @@ -32,17 +38,9 @@ Full documentation for the project is available at <>. } ``` -# Examples - -Demo is available at https://ts-factory.io/bublik/ - -# Documentation - -For now some documentation can be found in **doc/wiki** here. - -# Development +## Development -## Pre-commit checkings +### Pre-commit checkings After initial deploy please run the: ``` @@ -56,7 +54,7 @@ Please note that you can always disable the pre-commit validation by running: pre-commit uninstall ``` -## Checking your changes +### Checking your changes You can use pyformat script to check your changes. From 2b5879310b74b7eac7c25710a67901d9d5a12eee Mon Sep 17 00:00:00 2001 From: Natalia Rybchenko Date: Wed, 15 Oct 2025 11:39:54 +0300 Subject: [PATCH 3/3] readme: update installation instructions Revise and update installation instructions for accuracy. Signed-off-by: Natalia Rybchenko --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cceabb41f..78f2d3fcf 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,30 @@ Full documentation is available [here](https://ts-factory.github.io/bublik-relea - Python 3.10 or 3.11 or 3.12 or 3.13 ## Installation -1. Clone [bublik backend](https://github.com/ts-factory/bublik.git) to /opt/bublik/**bublik**. -2. Clone [bublik frontend](https://github.com/ts-factory/bublik-ui.git) to /opt/bublik/**bublik-ui**. -3. Clone [site-specific configuration](https://github.com/ts-factory/ts-rigs-sample.git) to /opt/bublik/**ts-rigs**. -4. Launch deploy script: +1. Clone [Bublik backend](https://github.com/ts-factory/bublik.git): ``` - cd /opt/bublik/bublik - ./scripts/deploy -c ol/selftest -H bublik-db -k /etc/bublik.keytab + git clone https://github.com/ts-factory/bublik.git ``` -5. Check to NGINX settings in /etc/nginx/sites-available/bublik: + +2. Launch the initial deployment script, specifying the host: + + ``` + ./scripts/init_deploy.sh + ``` + + You can also use the initial deployment and deployment options to provide additional parameters. + To see all available options, run: + + ``` + ./scripts/init_deploy.sh -h + ./scripts/deploy -h + ``` + + > **Important:** Make sure you have root (or `sudo`) access to the target host + > before running the initial deployment script. + +3. Check to NGINX settings in /etc/nginx/sites-available/bublik: ``` location /v2/ {