carta-controller 4.0.0-rc.0 → 4.1.0

package/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/src/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

package/README.md

@@ -1,7 +1,7 @@
 # CARTA Controller
 
-[![carta version](https://img.shields.io/badge/CARTA%20Version-4.0.0--rc.0-brightgreen)](https://github.com/CARTAvis/carta-backend/releases/tag/v4.0.0-rc.0)
-[![npm version](https://img.shields.io/npm/v/carta-controller/rc.svg?style=flat)](https://npmjs.org/package/carta-controller "View this project on npm")
+[![carta version](https://img.shields.io/badge/CARTA%20Version-4.1.0-brightgreen)](https://github.com/CARTAvis/carta-backend/releases/tag/v4.1.0)
+[![npm version](https://img.shields.io/npm/v/carta-controller?style=flat)](https://npmjs.org/package/carta-controller "View this project on npm")
 ![last commit](https://img.shields.io/github/last-commit/CARTAvis/carta-controller)
 ![commit activity](https://img.shields.io/github/commit-activity/m/CARTAvis/carta-controller)
 

package/dist/controllerTests.js

@@ -188,7 +188,8 @@ function testBackendStartup(username) {
             "-u",
             `${username}`,
             config_1.ServerConfig.processCommand,
-            "--no_http",
+            "--no_frontend",
+            "--no_database",
             "--debug_no_auth",
             "--port",
             `${port}`,

package/dist/serverHandlers.js

@@ -185,7 +185,8 @@ function startServer(username) {
                 "-u",
                 `${username}`,
                 config_1.ServerConfig.processCommand,
-                "--no_http",
+                "--no_frontend",
+                "--no_database",
                 "--port",
                 `${port}`,
                 "--top_level_folder",

package/dist/util.js

@@ -41,29 +41,12 @@ function verboseError(...args) {
 }
 exports.verboseError = verboseError;
 function getUserId(username) {
-    var _a;
     if (!username) {
         throw new Error("Missing argument for username");
     }
-    let usernameRegex = undefined;
-    if (process.env.NAME_REGEX) {
-        try {
-            usernameRegex = new RegExp(process.env.NAME_REGEX);
-        }
-        catch (err) {
-            console.warn(err);
-        }
-    }
-    if (!usernameRegex) {
-        // As specified in useradd manpage
-        usernameRegex = /^[a-z_][a-z0-9_-]*[$]?$/gm;
-    }
-    if (!username.match(usernameRegex)) {
-        throw new Error("Malformed argument for username");
-    }
-    const result = (_a = (0, child_process_1.spawnSync)("id", ["-u", username])) === null || _a === void 0 ? void 0 : _a.stdout;
-    if (result) {
-        const uid = Number.parseInt(result);
+    const result = (0, child_process_1.spawnSync)("id", ["-u", username]);
+    if (!result.status && (result === null || result === void 0 ? void 0 : result.stdout)) {
+        const uid = Number.parseInt(result.stdout);
         if (isFinite(uid)) {
             return uid;
         }

package/docs/src/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'CARTA Controller'
-copyright = '2021, Angus Comrie, Adrianna Pińska and Robert Simmonds'
-author = 'Angus Comrie, Adrianna Pińska and Robert Simmonds'
+copyright = '2021, Angus Comrie, Adrianna Pińska, David Aikema and Robert Simmonds'
+author = 'Angus Comrie, Adrianna Pińska, David Aikema and Robert Simmonds'
 
 # The full version, including alpha/beta/rc tags
-release = '4.0.0-rc.0'
+release = '4.1.0'
 
 
 # -- General configuration ---------------------------------------------------

package/docs/src/configuration.rst

@@ -147,10 +147,11 @@ To test the configuration of the controller, you can use the built-in test featu
     [
     'running sudo --preserve-env=CARTA_AUTH_TOKEN -n -u alice /usr/bin/carta_backend --no_http --debug_no_auth --port 3499 --top_level_folder /usr/share/carta --no_log /usr/share/carta'
     ]
-    [2021-11-30 12:28:48.207] [info] /usr/bin/carta_backend: Version 4.0.0-rc.0
-    [2021-11-30 12:28:48.209] [info] Listening on port 3499 with top level folder /usr/share/carta, starting folder /usr/share/carta. The number of OpenMP worker threads will be handled automatically.
+    [2024-01-19 08:30:05.888Z] [CARTA] [info] /usr/bin/carta_backend: Version 4.1.0
+    [2024-01-19 08:30:05.888Z] [CARTA] [info] Listening on port 3499 with top level folder /usr/share/carta, starting folder /usr/share/carta, and 8 OpenMP worker threads
     ✔ Backend process started successfully
-    [2021-11-30 12:28:50.169] [info] Session 1 [127.0.0.1] Connected. Num sessions: 1
+    [2024-01-19 08:30:07.850Z] [CARTA] [info] 0x561f1a635180 ::Session (1235524527:1)
+    [2024-01-19 08:30:07.850Z] [CARTA] [info] Session 1235524527 [127.0.0.1] Connected. Num sessions: 1
     ✔ Backend process accepted connection
     [ 'running sudo -u alice ./scripts/carta_kill_script.sh 54275' ]
     ✔ Backend process killed correctly

package/docs/src/index.rst

@@ -25,11 +25,11 @@ We officially support Ubuntu 18.04 and 20.04, and RHEL 7 and 8 (and their freely
    schema
    schema_backend
 
-.. |backend-github| image:: https://img.shields.io/badge/CARTA%20Version-4.0.0--rc.0-brightgreen
+.. |backend-github| image:: https://img.shields.io/badge/CARTA%20Version-4.1.0-brightgreen
         :alt: View this backend version on GitHub
-        :target: https://github.com/CARTAvis/carta-backend/releases/tag/v4.0.0-rc.0
+        :target: https://github.com/CARTAvis/carta-backend/releases/tag/v4.1.0
 
-.. |npm-package| image:: https://img.shields.io/npm/v/carta-controller/rc.svg?style=flat
+.. |npm-package| image:: https://img.shields.io/npm/v/carta-controller?style=flat
         :alt: View this project on npm
         :target: https://npmjs.org/package/carta-controller
 

package/docs/src/introduction.rst

@@ -10,7 +10,7 @@ The CARTA controller provides a simple dashboard which authenticates users and a
 Dependencies
 ------------
 
-To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it. You should use the ``v4.0.0-rc.0`` tag of `the CARTA backend <https://github.com/CARTAvis/carta-backend>`_.
+To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it. You should use the ``v4.1.0`` tag of `the CARTA backend <https://github.com/CARTAvis/carta-backend>`_.
 
 By default, the controller runs on port 8000. It should be run behind a proxy, so that it can be accessed via HTTP and HTTPS. 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "carta-controller",
-    "version": "4.0.0-rc.0",
+    "version": "4.1.0",
     "description": "NodeJS-based controller for CARTA",
     "repository": "https://github.com/CARTAvis/carta-controller",
     "homepage": "https://www.cartavis.org",
@@ -24,7 +24,7 @@
         "ajv-formats": "^2.1.0",
         "axios": "^0.27.2",
         "body-parser": "^1.19.0",
-        "carta-frontend": "4.0.0-rc.0",
+        "carta-frontend": "^4.1.0",
         "chalk": "^4.1.2",
         "compression": "^1.7.4",
         "cookie-parser": "^1.4.5",

package/docs/_build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: da393b3be735681649122eea563dee26
-tags: 645f666f9bcd5a90fca523b33c5a78b7

package/docs/_build/html/_sources/almalinux8_instructions.rst.txt

@@ -1,255 +0,0 @@
-.. _almalinux8_instructions:
-
-Step-by-step instructions for AlmaLinux 8
-=========================================
-
-.. note::
-
-    These instructions should also work for RHEL 8 and Rocky Linux 8. Some changes may be necessary for RHEL 7 / CentOS 7.
-
-
-1. Install Node.js
-~~~~~~~~~~~~~~~~~~
-
-The CARTA controller uses `Node.js <https://nodejs.org/>`_ and supports v12, v14, and v16. Node.js can easily be installed from the AlmaLinux 8 AppStream repository. Here we install v14, as well as the ``npm`` package manager.
-
-.. code-block:: shell
-
-    # Install Node.js v14:
-    sudo dnf module enable nodejs:14
-    sudo dnf install -y nodejs npm
-
-    # Check it is installed and working:
-    node --version
-    npm --version
-
-2. Install MongoDB
-~~~~~~~~~~~~~~~~~~
-
-The CARTA controller uses `MongoDB <https://www.mongodb.com/>`_ to store user preferences, etc.. MongoDB is not available through the default AlmaLinux 8 repositories, but we can add a custom repository to install it more easily.
-
-.. code-block:: shell
-    
-    # Create a custom MongoDB repo file:
-    sudo cat <<EOT >> /etc/yum.repos.d/mongodb-org.repo
-    [mongodb-org-4.4]
-    name=MongoDB Repository
-    baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/4.4/x86_64/
-    gpgcheck=1
-    enabled=1
-    gpgkey=https://www.mongodb.org/static/pgp/server-4.4.asc
-    EOT
-
-    # Install MongoDB:
-    sudo dnf update
-    sudo dnf install -y mongodb-org
-    
-    # Start and enable MongoDB to run on startup:
-    sudo systemctl start mongod
-    sudo systemctl enable mongod
-
-    # Check that it is working
-    sudo systemctl status mongod
-
-.. note::
-
-    On RHEL7/CentOS7, MongoDB v14 can be installed as follows:
-    ``curl -fsSL https://rpm.nodesource.com/setup_14.x | bash - && yum install -y nodejs``
-
-
-3. Install the CARTA controller
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The easiest way to install the CARTA controller is using ``npm``. 
-
-.. code-block:: shell
-
-    sudo dnf install -y python3 make gcc-c++
-    sudo npm install -g --unsafe-perm carta-controller
-
-.. note::
-
-    The CARTA controller executable will be installed at ``/usr/local/lib/node_modules/carta-controller``.
-    The CARTA frontend will be installed at ``/usr/local/lib/node_modules/carta-controller/node_modules/carta-frontend/build``.
-
-.. note::
-    
-    Do not pass the ``--unsafe-perm`` flag to ``npm`` if using a local install.
-
-.. note::
-    
-    On RHEL7/CentOS7 the CARTA controller package can not run with the default gcc version 4.8.5 (there would be an error due to ``node-linux-pam``). 
-    A work around is to install a newer GCC version from source in order to get a newer ``libstdc++.so.6``, then add the location of the newer 
-    ``libstdc++.so.6`` to the LD_LIBRARY_PATH. After that, the CARTA controller can run on RHEL7/CentOS7.
-
-
-
-4. Install the CARTA backend
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The easiest way is to install the CARTA backend is from our `cartavis/carta Copr <https://copr.fedorainfracloud.org/coprs/cartavis/carta/>`_ repository.
-
-.. code-block:: shell
-
-    # Install the CARTA backend
-    sudo dnf -y install 'dnf-command(copr)'
-    sudo dnf -y copr enable cartavis/carta
-    sudo dnf -y install epel-release
-    sudo dnf -y install carta-backend
-
-    # Check that the backend can run and matches the major version number of the controller.
-    # Please note, we currently install the version of carta_backend in a non-standard location.
-    /opt/carta/bin/carta_backend --version
-
-
-5. Install Nginx
-~~~~~~~~~~~~~~~~
-
-The CARTA controller requires a webserver. Here we use `NGINX <https://www.nginx.com/>`_, but Apache should work too.
-
-.. code-block:: shell
-
-    # Install nginx:
-    sudo dnf install -y nginx
-    sudo systemctl start nginx
-    sudo systemctl enable nginx
-    sudo setsebool -P httpd_can_network_connect 1
-    sudo firewall-cmd --permanent --zone=public --add-service=http
-    sudo firewall-cmd --permanent --zone=public --add-service=https
-    sudo firewall-cmd --reload
-
-    # Set up the nginx configuration file using our sample configuration file linked below:
-    sudo cd /etc/nginx/conf.d/
-    sudo vi /etc/nginx/conf.d/carta.conf
-    sudo systemctl restart nginx
-
-    # Check it is running:
-    sudo systemctl status nginx
-
-A :ref:`sample configuration file<example_nginx>` is provided in the configuration section. This should be adapted to your server configuration.
-
-.. note::
-    If there are problems, you can debug with ``journactl -xe`` and by checking log files in ``/var/log/nginx/``.
-
-
-6. Create the 'carta' user and modify sudoers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-For security, we recommend not to run the CARTA controller as the root user. Therefore we create a new user called ``carta``. 
-
-We will assign the group ``carta-users`` to every user account and enable them to run ``/usr/bin/carta_backend`` and the script to close the CARTA backend, ``/usr/local/bin/carta-kill-script``, by adding a custom entry to the ``sudoers`` file.
-
-.. code-block:: shell
-    
-    # Create the carta user:
-    sudo adduser carta
-    # Check everything is OK
-    id carta
-    # It should show 'uid=1000(carta) gid=1000(carta) groups=1000(carta)'
-
-    # So that log files can be written:
-    sudo mkdir -p /var/log/carta
-    sudo chown -R carta /var/log/carta
-
-    # Add the custom sudoers file entry using our sample linked below
-    sudo visudo -f /etc/sudoers.d/carta_controller
-    
-An :ref:`example sudoers configuration<example_sudoers>` is provided in the configuration section.
-
-.. note::
-    The only safe way to modify sudoers is using ``visudo``. Any syntax errors from directly editing sudoers could make your system unusable.
-
-.. note::
-    The ``carta`` user should not be in the ``carta-users`` group. ``carta-users`` should only be assigned to the normal user accounts.
-
-.. note::
-    As we install the version of the carta_backend in a non-standard location, please remember to change the path to the carta_backend executable in the custom sudoers file:
-
-   .. code-block:: bash
-
-      carta ALL=(%carta-users) NOPASSWD:SETENV: /opt/carta/bin/carta_backend
-
-7. Set up the user authentication method
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This is the most difficult step and depends on how you authenticate users at your institute. In this step-by-step guide we use PAM local authentication and a local user, ``bob``, on the server running the CARTA controller. The user ``bob`` needs to be part of the ``carta-users`` group.
-
-With PAM authentication, the ``carta`` user that runs the CARTA controller requires access to the ``/etc/shadow`` file in order to authenticate other users. We can enable this by creating a new group called ``shadow`` and assigning the ``/etc/shadow`` file to that group.
-
-.. note::
-    Only PAM with local authentication requires ``/etc/shadow`` access. PAM using LDAP, and Google OAuth, do not require ``/etc/shadow`` access. 
-
-.. code-block:: shell
-
-    # Create the test user 'bob':
-    sudo useradd -G carta-users bob
-    sudo passwd bob
-
-    # A new group called 'shadow' needs to be assinged to the /etc/shadow file and user 'carta':
-    sudo groupadd shadow
-    sudo chgrp shadow /etc/shadow
-    sudo chmod g+r /etc/shadow
-    sudo usermod -a -G shadow carta
-    ls -l /etc/shadow
-    # It should show permissions as ----r-----. 1 root shadow
-    # It could be helpful to reboot the server at this point
-    sudo reboot 
-
-
-8. Configure the CARTA controller
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Create and fill in the ``config.json`` using our :ref:`sample configuration file<example_config>`. 
-Also generate private/public keys as they are used by the CARTA controller to sign/verify/refresh access tokens.
-
-.. code-block:: shell
-
-    sudo mkdir /etc/carta
-    sudo chown -R carta /etc/carta
-    vi /etc/carta/config.json
-    
-    # Generate private/public keys:
-    cd /etc/carta
-    sudo openssl genrsa -out carta_private.pem 4096
-    sudo openssl rsa -in carta_private.pem -outform PEM -pubout -out carta_public.pem
-
-Please check the `CARTA Configuration Schema <https://carta-controller.readthedocs.io/en/latest/schema.html#schema>`_ for all available options.
-
-
-9. Check everything is working
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Here we switch to the ``carta`` user and test the CARTA controller with our test user ``bob``:
-
-.. code-block:: shell
-
-    su - carta
-    carta-controller -verbose -test bob
-
-If the test is successful, the CARTA controller should be ready to deploy.
-
-
-10. Start the CARTA controller
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: shell
-
-    su - carta
-    carta-controller
-
-Now your users should be able to access your server's URL and log into CARTA.
-
-
-Optional: Set up the CARTA controller to run with pm2
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-`pm2 <https://pm2.keymetrics.io/>`_ is a very convenient tool to keep the CARTA controller service running in the background, and even start it up automatically after a reboot.
-
-.. code-block:: shell
-
-    sudo npm install -g pm2
-    su -carta
-    pm2 start carta-controller
-
-Please refer to the `pm2 documentation <https://pm2.keymetrics.io/docs/usage/startup/>`_ for detailed instructions.
-