Merge pull request #30 from vidispine/25.1.0

25.1.0

Author: alexjennings

.github/workflows/build-with-public-url.yml

@@ -11,25 +11,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '20'
+          cache: 'npm'
       - name: Set artifact vars
         id: artifact-vars
         run: |
           echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
           echo "encoded_url=$(node -p "encodeURIComponent('${{ github.event.inputs.public_url }}')")" >> $GITHUB_OUTPUT
-      - name: Cache node_modules
-        id: cache-modules
-        uses: actions/cache@v3
-        with:
-          path: |
-            node_modules
-            */*/node_modules
-          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
       - name: Install dependencies
-        if: steps.cache-modules.outputs.cache-hit != 'true'
-        run: npm install
+        run: npm ci
       - name: Build site
         run: PUBLIC_URL=${PUBLIC_URL} GENERATE_SOURCEMAP=false npm run build
         env:

.github/workflows/docker-image.yml

@@ -8,17 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
           node-version: '20'
-      - name: Cache node_modules
-        id: cache-modules
-        uses: actions/cache@v2
-        with:
-          path: |
-            node_modules
-            */*/node_modules
-          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+          cache: 'npm'
       - name: Configure npm
         run: npm config set script-shell bash
       - name: Set up QEMU
@@ -29,8 +22,7 @@ jobs:
         run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u ${{ secrets.DOCKERHUB_USER }} --password-stdin
         shell: bash
       - name: Install app dependencies
-        if: steps.cache-modules.outputs.cache-hit != 'true'
-        run: npm install
+        run: npm ci
         shell: bash
       - name: Build the Docker image
         run: PUBLIC_URL=/admin-tool npm run docker:buildx:push

.github/workflows/gh-pages.yml

@@ -7,21 +7,13 @@ jobs:
   build_and_publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: '20'
-      - name: Cache node_modules
-        id: cache-modules
-        uses: actions/cache@v2
-        with:
-          path: |
-            node_modules
-            */*/node_modules
-          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+          cache: 'npm'
       - name: Install dependencies
-        if: steps.cache-modules.outputs.cache-hit != 'true'
-        run: npm install
+        run: npm ci
       - name: Clean cached clones
         run: npm run gh-pages-clean
       - name: Publish to GitHub Pages

README.md

@@ -65,6 +65,11 @@ Docker Containers can be downloaded from Dockerhub https://hub.docker.com/r/vidi
 
 ### Run
 
+* Pull the latest image
+```
+docker image pull vidispine/admin-tool:latest
+```
+
 * Start the container with the latest image.
   - Try changing the port from `-p 80:80` to `-p 8088:80` if running on Windows. 
 ```
@@ -79,6 +84,19 @@ docker run \
   'vidispine/admin-tool:latest'
 ``` 
 
+* Alternatively, start the container without specifying a VidiCore server.
+```
+docker run \
+  --name vidispine-admin-tool \
+  --detach \
+  --tty \
+  --interactive \
+  --rm \
+  -e CONTAINER_PROXY='true' \
+  -p 80:80 \
+  'vidispine/admin-tool:latest'
+``` 
+
 * Alternatively, use `docker compose` with the linked [`docker-compose.yaml`](./docker-compose.yaml).
 ```
 docker compose up -d \
@@ -97,6 +115,7 @@ docker compose up -d \
 * **NGINX_RESOLVER**: Nginx will proxy requests to an upstream VidiCore server, this will require a DNS address for the [resolver](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver) if using a hostname.
   - Set this to `127.0.0.11` if using within Docker Compose.
   - Set this to `169.254.169.253` if using in AWS ECS (or your [Route 53 Resolver](https://docs.aws.amazon.com/vpc/latest/userguide/AmazonDNS-concepts.html#AmazonDNS)).
+* **CONTAINER_PROXY**: Sets the `X-Proxy-URL` header on frontend requests and proxy via Nginx.
 
 #### Ports
 

TODO.md

@@ -6,11 +6,11 @@ TO-DO
 3. ~~Deletion lock notifications~~
 4. ~~Deletion locks on files~~
 5. ~~Deletion locks on libraries~~
-6. Search users
+6. ~~Search users~~
 7. User graph
 8. Search groups
 9. Traverse groups
-10. ACL graph
+10. ~~ACL graph~~
 11. Collection items
 12. Create an item list job for the collection
 13. Add entity to collection with additional params (before, reference)
@@ -31,7 +31,7 @@ TO-DO
 28. Create item list job
 29. List all libraries containing item
 30. Item locks
-31. Item sequences
+31. ~~Item sequences~~
 32. Item loudness
 33. Item waveform
 34. Item highlights

docker-compose.yaml

@@ -4,6 +4,6 @@ services:
     environment:
       VIDISPINE_URL: ${VIDISPINE_URL:-http://host.docker.internal:8080}
       NGINX_RESOLVER: 127.0.0.11
+      CONTAINER_PROXY: true
     ports:
-      - ${ADMINTOOL_PORT:-80}:80
-
+      - ${ADMINTOOL_PORT:-80}:80

index.html

@@ -8,6 +8,7 @@
     <link rel="shortcut icon" href="/favicon.ico">
     <script type="text/javascript">
         var VIDISPINE_URL = "$VIDISPINE_URL";
+        var CONTAINER_PROXY = "$CONTAINER_PROXY";
     </script>
     <title>VidiCore Admin</title>
     <style>

package-lock.json

@@ -1,14 +1,14 @@
 {
   "name": "@vidispine/admin-tool",
-  "version": "24.4.0",
+  "version": "25.1.0",
   "private": true,
   "dependencies": {
     "@devbookhq/splitter": "^1.3.2",
     "@fontsource/open-sans": "4.5.2",
     "@material-ui/core": "4.12.3",
     "@material-ui/icons": "4.11.2",
-    "@vidispine/vdt-api": "24.3.0-pre.3",
-    "@vidispine/vdt-js": "24.3.0-pre.3",
+    "@vidispine/vdt-api": "24.4.0-pre.1",
+    "@vidispine/vdt-js": "24.4.0-pre.1",
     "clsx": "1.1.1",
     "codemirror": "5.65.9",
     "d3-graphviz": "5.4.0",

package.json

@@ -16,7 +16,15 @@ server {
     set $vsurl "${VIDISPINE_URL}";
 
     location ~ ^/(API|APInoauth|APIinit|APIdoc)/.* {
-        proxy_pass   $vsurl;
+        set $target_url $http_x_proxy_url;
+        if ($target_url ~* ^https?://) {
+            proxy_pass $target_url;
+        }
+
+        if ($target_url = "") {
+            proxy_pass   $vsurl;
+        }
+
         proxy_hide_header WWW-Authenticate;
         proxy_request_buffering off;
         proxy_http_version 1.1;