Merge pull request #6 from FNNDSC/store-integration

Blog on the store integration with the ChRIS_ui
FNNDSC · Sep 30, 2024 · a736f53 · a736f53
2 parents a284e05 + 6a4bfb5
commit a736f53
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 0 deletions.
diff --git a/blog/2024-09-30-store-integration/Login.png b/blog/2024-09-30-store-integration/Login.png
diff --git a/blog/2024-09-30-store-integration/config_1.png b/blog/2024-09-30-store-integration/config_1.png
diff --git a/blog/2024-09-30-store-integration/config_2.png b/blog/2024-09-30-store-integration/config_2.png
diff --git a/blog/2024-09-30-store-integration/index.md b/blog/2024-09-30-store-integration/index.md
@@ -0,0 +1,50 @@
+---
+title: Store Integration with the ChRIS_ui
+authors: gideon
+tags: [frontend, react, store, plugins]
+---
+
+When you install ChRIS using miniChRIS Docker, you might need additional plugins on your machine. This guide explains how to install plugins from the ChRIS Store into your local ChRIS instance. We'll cover the steps to configure and use the ChRIS Store, both when logged in as a staff user and when not logged in.
+
+By default, the local UI points to https://cube.chrisproject.org/api/v1/, which acts as a central repository for installing plugins on your local cube. The goal is straightforward: you need plugins on your local UI, and you can install them from the store. Currently, https://cube.chrisproject.org requires CORS settings configuration, but if you're on an internal network, you can point the UI to a different store.
+
+There are two modes to configure the UI:
+
+1. Logged in as a admin user
+2. Not logged in or non-admin user
+If you've set up the UI and backend using miniChRIS Docker, the admin username is chris and the password is chris1234. Let's start with the workflow for a logged-in user.
+
+### Workflow for Logged-In Admin Users
+
+1 Log in.
+
+Once logged in, click on the Configure the Store button.
+
+![Screenshot of the Login Screen](./Login.png)
+
+2. Configure the Store Settings.
+
+You'll see some pre-filled values. If you're on the internal network, point your UI to the internal store example. Since you're already authenticated as an admin user, you don't need to configure the admin username and password for the chris-admin website. You can keep it as the default.
+
+![Screenshot of the config form](./config_1.png)
+
+3. Save and Install Plugins.
+
+After clicking Save, your UI should populate with all the available plugins. Click Install on any plugin to install it.
+
+[store](./store.png)
+
+
+### Configurations for Non-Staff or Not Logged-In Users
+
+If you're not logged in, you'll need to provide the username and password for the chris-admin website in the configuration form. For a local setup, use chris for the username and chris1234 for the password. Additionally, ensure the compute resource input box is correctly set. In this example, the compute resource is named argentum. Click Save to install plugins without logging in.
+
+![Screenshot of the config form for unauthenticated users](./config_2.png)
+
+
+This configuration also applies to non-admin users.
+
+### Uploading Pipeline Source Files
+With the store correctly set and plugins installed, you can upload pipeline source files in .json and .yml formats. The UI will automatically upload any missing plugins required for the pipeline, regardless of whether you're an admin or non-admin user.
+
+![Screenshot for the pipeline upload](./pipeline_upload.png)
diff --git a/blog/2024-09-30-store-integration/pipeline_upload.png b/blog/2024-09-30-store-integration/pipeline_upload.png
diff --git a/blog/2024-09-30-store-integration/store.png b/blog/2024-09-30-store-integration/store.png
diff --git a/blog/2024-09-30-store-integration/unauthenticated.png b/blog/2024-09-30-store-integration/unauthenticated.png