Skip to main content

Deploy from Scratch

warning

Documentation is currently in progress.
Please check back later for updates.

Prerequisites​

Before beginning the deployment process, ensure you have:

  • Root/sudo access to your system
  • Git installed
  • Internet connection for downloading packages
  • Basic knowledge of Linux command line

Tested on

Distributor ID: Ubuntu
Description:    Ubuntu 24.04.1 LTS
Release:        24.04
Codename:       noble

Install system dependencies

sudo apt-get update \
  && sudo apt-get install -y --no-install-recommends \
  gettext \
  python3-celery \
  rsync \
  flex \
  bison \
  ninja-build \
  libjansson-dev \
  libjansson-doc \
  libjansson4 \
  libpopt-dev \
  libpcre3-dev \
  pixz \
  libxml-parser-perl \
  build-essential \
  curl \
  libkrb5-dev \
  libffi-dev \
  libxml2-dev \
  libyaml-dev \
  libssl-dev \
  libglib2.0-dev \
  git \
  python3.12-venv \
  build-essential \
  python-is-python3 \
  2to3 \
  libkrb5-dev \
  libffi-dev \
  unzip \
  python-is-python3 \
  python3.12-dev \
  && cpan -T JSON

Building Test Environment​

1. Clone the Repository​

git clone https://github.com/ts-factory/test-environment.git
cd ./test-environment

2. Set Up Python Virtual Environment​

python3 -m venv .venv
source .venv/bin/activate

3. Install Meson Build System​

pip install meson==1.6.1

4. Build the Test Environment​

./dispatcher.sh -q --conf-builder=builder.conf.tools --no-run

5. Update System PATH​

echo "export PATH=\"$(pwd)/build/inst/default/bin:\$PATH\"" >> ~/.bashrc
source ~/.bashrc

Database Setup​

warning

Documentation is currently in progress.
Please check back later for updates.

Cache Setup​

warning

Documentation is currently in progress.
Please check back later for updates.

Flower & Celery Setup​

warning

Documentation is currently in progress.
Please check back later for updates.

Kerberos Setup​

warning

Documentation is currently in progress.
Please check back later for updates.

UI Setup​

Prerequisites​

  1. Install fnm
  2. Install node via fnm fnm install --lts
  3. Install pnpm npm install -g pnpm@latest-10
  4. Install nx pnpm install -g nx

Build UI​

1. Clone repo​

git clone https://github.com/ts-factory/bublik-ui
cd ./bublik-ui

2. Install Dependencies​

pnpm install --frozen-lockfile

3. Build UI​

Refer to documentation for UI for more information

BASE_URL="/v2" nx run bublik:build --base="/v2" --sourcemap="true"

4. You can find output at dist/apps/bublik​

UI Docs Setup​

Prerequisites​

  1. Install fnm
  2. Install node via fnm fnm install --lts
  3. Install pnpm npm install -g pnpm@latest-10

Build Docs​

1. Clone repo​

git clone https://github.com/ts-factory/bublik-release
cd ./bublik-release

2. Install Dependencies​

pnpm install --frozen-lockfile

3. Build Docs​

Refer to documentation for UI for more information

BASE_URL="/docs/" URL="http://localhost" pnpm build

4. You can find output at ./build​

Backend Setup​

1. Clone the Backend Repository​

git clone https://github.com/ts-factory/bublik.git
cd bublik

2. Set Up Python Virtual Environment​

python3 -m venv .venv
source .venv/bin/activate

3. Install Python Dependencies​

pip install -r requirements.txt

4. After Deployment​

  • Create superuser with ./manage.py createsuperuser
  • Once deployment is successful, you can fine-tune the configurations to suit your needs.

Post-Deployment Steps​

After successful deployment:

  1. Verify the installation by running basic system checks (documentation pending)
  2. Configure the system according to your needs by referring to the Configuration Guide
  3. Set up monitoring and logging (documentation pending)
  4. Implement backup procedures (documentation pending)

Troubleshooting​

If you encounter issues during deployment:

  • Check system logs for errors
  • Ensure all prerequisites are properly installed
  • Verify system requirements are met
  • Contact support if issues persist

Status​

warning

This documentation is currently under development.
Please check back regularly for updates and additional information.

Contributing​

We welcome contributions to improve this documentation. Please submit pull requests or open issues in the repository.