Nuclia RAG-as-a-Service

Prerequisites

First you need to have NVM, NODE and YARN installed.

To install nvm, run:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

or

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

To check if it was installed properly, close and reopen the terminal and run command -v nvm and should return nvm. In case there is something else going on, troubleshoot with this documentation. To see all the commands, simply run nvm.

To install the latest stable version of node, run:

nvm install --lts

To check if node and npm is properly installed, run: node --version and npm --version. _{Any problems should be resolved with the nvm documentation.}

To install yarn, run:

npm install --global yarn

Check if Yarn is installed by running: yarn --version.

Note

In the rest of this documentation, we use commands like nx and missdev. Those can be find in node_modules/.bin folder. To use them directly you can add node_modules/.bin folder to your command line path. You can also install nx globally:

npm install -g nx

Dependencies installation

yarn

Pastanaga-angular installation must be done through missdev so sistema-demo can run:

yarn missdev

If it fails for any reason, you can try to clone Pastanaga manually:

cd libs
git clone git@github.com:plone/pastanaga-angular.git

Required top-level block (even if empty)

events {}

http { # Keep logs local to this temp project (optional) access_log logs/access.log; error_log logs/error.log;

# Recommended: tighter proxy defaults proxy_http_version 1.1; proxy_set_header Host $host; proxy_set_header X-Forwarded-Proto https; proxy_set_header X-Forwarded-For $remote_addr;

server { # You'll need sudo to bind to 443 on macOS listen 443 ssl; server_name auth.gcp-global-dev-1.nuclia.io;

# >>> Replace these with your mkcert outputs <<< ssl_certificate auth.gcp-global-dev-1.nuclia.io.pem; ssl_certificate_key auth.gcp-global-dev-1.nuclia.io-key.pem;

# Forward EVERYTHING under this host to your Angular dev server location / { proxy_pass http://127.0.0.1:4201; } } }

External dependencies

We used to load some external libs from cdn.jsdelivr.net or cd./dashjs.net, but it was sometimes conflicting with some customers security policy.

So the following files have been manually uploaded in the Nuclia CDN:

https://cdn.jsdelivr.net/npm/marked/marked.min.js https://cdn.jsdelivr.net/npm/pdfjs-dist@2.16.105/build/pdf.min.js https://cdn.jsdelivr.net/npm/pdfjs-dist@2.16.105/build/pdf.worker.js\n https://cdn.jsdelivr.net/npm/pdfjs-dist@2.16.105/web/pdf_viewer.css https://cdn.dashjs.org/v4.7.1/dash.all.min.js

CI/CD Deployment

Deploying to stage

When merging a PR, if it impacts the manager app, it is built and our deploy_manager job (in our deploy GitHub Action) will update Helm and then trigger a Repository Dispatch event to the frontend_deploy repo.

That's how the manager is deployed to stage.

You can see the deployment on Stage ArgoCD.

SDK

Documentation