Xronos features and improvements

.gitignore

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: (c) 2024 Yuqi Huai.
+# SPDX-License-Identifier: BSD-3-Clause
+# Modifications Copyright (c) 2025 Xronos Inc.
 
 # Created by https://www.toptal.com/developers/gitignore/api/macos,windows,node,react
 # Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,node,react

README.md

@@ -23,6 +23,16 @@
 
 ---
 
+## Download from Docker Hub
+
+The images built from this source repository are available on Docker Hub:
+
+- [densosvic/sora-svl-server](https://hub.docker.com/repository/docker/densosvic/sora-svl-server)
+- [densosvic/sora-svl-client](https://hub.docker.com/repository/docker/densosvic/sora-svl-client)
+- [densosvic/sora-svl-mongo](https://hub.docker.com/repository/docker/densosvic/sora-svl-mongo)
+- [densosvic/sora-svl-router](https://hub.docker.com/repository/docker/densosvic/sora-svl-router)
+- [densosvic/sora-svl-docs](https://hub.docker.com/repository/docker/densosvic/sora-svl-docs)
+
 ## About the Project
 
 [LGSVL Simulator](https://github.com/lgsvl/simulator) has been a powerful simulator that made many research projects possible. Unfortunately, LG has made the difficult decision to suspend active development of SVL Simulator, as of January 1, 2022. The official statement says the cloud will be up and running through at least **Thursday, June 30, 2022**.
@@ -59,20 +69,11 @@ I would greatly appreciate it if you could cite this work in addition to the app
 
 1. Install Docker
 2. Clone the project
-3. Download assets needed from [Google Drive](https://drive.google.com/drive/folders/10KX_VKcahLyV40mGoUWhrfjtE02IqOuq) and unzip them in `server/assets`. (preview, maps, plugins, vehicles, hdmaps)
-
-   > Since the compressed file for entire maps directory is too large, you will have to manually download map asset individually from the Google Drive folder.
-   > Also, when downloading individual asset file, make sure there is no file extension. Google sometimes automatically adds ".zip" to the end, make sure to remove this from the filename. See https://github.com/YuqiHuai/SORA-SVL/issues/33#issuecomment-1429161897
-   >
-   > UPDATE 2022-06-30: WISE provides geojson for some of the maps. To access those geojson, download `geojson.json` from Google Drive, and then import them into MongoDB.
-   >
-   > UPDATE 2024-09-30: For users in China, please download from [Baidu Drive](https://pan.baidu.com/s/1w_Ik7lPdefAalWR_c22DoQ?pwd=ey7p). Also see https://github.com/YuqiHuai/SORA-SVL/issues/84#issuecomment-2296465522 and https://github.com/YuqiHuai/SORA-SVL/issues/89#issuecomment-2370252260
+3. Run `docker compose up --build -d`
+4. Local SVL Cloud will be available at "http://localhost"
+5. Add `config.yml` to the root directory of SVL client with the following content:
 
-4. Run `docker compose up --build -d`
-5. Local SVL Cloud will be available at "http://localhost"
-6. Add `config.yml` to the root directory of SVL client with the following content:
-
-   ```
+   ```toml
    headless: false
    read_only: false
    api_hostname: "localhost"
@@ -84,7 +85,7 @@ I would greatly appreciate it if you could cite this work in addition to the app
    > 
    > See documentation from [SVL archive](https://www.svlsimulator.com/docs/user-interface/config-and-cmd-line-params/).
 
-7. Now, SVL Client can be used without WISE.
+6. Now, SVL Client can be used without WISE.
 
 ## Future Plans
 
@@ -94,10 +95,16 @@ I would greatly appreciate it if you could cite this work in addition to the app
 - [ ] Allow creating new vehicle sensor configurations
 - [ ] Add cluster feature to the cloud
 - [x] Allow website to reflect client connection status.
-- [ ] Host assets at a different location
+- [x] Host assets at a different location
 
 ## Known Issues
 
+- Unable to download WISE assets during Docker build
+
+  The assets used in this build are downloaded from Amazon AWS S3 buckets hosted in `us-east-1`. These are public files but may not be available in all countries.
+
+  For users in China, please download from [Baidu Drive](https://pan.baidu.com/s/1w_Ik7lPdefAalWR_c22DoQ?pwd=ey7p) and substitute these files for the downloads in the Dockerfile. Also see https://github.com/YuqiHuai/SORA-SVL/issues/84#issuecomment-2296465522 and https://github.com/YuqiHuai/SORA-SVL/issues/89#issuecomment-2370252260
+
 - It is possible that permission settings related to Docker can cause project to fail (unable to load preview, unable to download assets). See https://github.com/YuqiHuai/SORA-SVL/issues/11#issuecomment-1173008100
 - I recommend installing docker following instructions in https://docs.docker.com/engine/install/ubuntu/
 - There may be issues with npm/docker image which causes `docker compose up -d` to fail, see https://github.com/YuqiHuai/SORA-SVL/issues/84#issuecomment-2296465522 and https://github.com/YuqiHuai/SORA-SVL/issues/89#issuecomment-2370252260

client/.env

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: (c) 2024 Yuqi Huai.
+# SPDX-License-Identifier: BSD-3-Clause
+# Modifications Copyright (c) 2025 Xronos Inc.
+
 REACT_APP_SERVER_URL=http://localhost

client/.gitignore

@@ -1,4 +1,6 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# SPDX-FileCopyrightText: (c) 2024 Yuqi Huai.
+# SPDX-License-Identifier: BSD-3-Clause
+# Modifications Copyright (c) 2025 Xronos Inc.
 
 # dependencies
 /node_modules

client/Dockerfile

@@ -1,17 +1,70 @@
-FROM node
+# SPDX-FileCopyrightText: (c) 2024 Yuqi Huai.
+# SPDX-License-Identifier: BSD-3-Clause
+# Modifications Copyright (c) 2025 Xronos Inc.
 
+ARG BUILDKIT_SBOM_SCAN_CONTEXT=false
+ARG BUILDKIT_SBOM_SCAN_STAGE=false
+
+##################
+## dependencies stage
+##################
+ARG BASEIMAGE=node:23.6.1-slim
+FROM ${BASEIMAGE} AS base
+
+RUN mkdir -p /app
+RUN chown node:node /app
+
+USER node
+WORKDIR /app
+
+# install node dependencies
+ENV NODE_ENV=production
+COPY --chown=node:node package.json /app/
+COPY --chown=node:node package-lock.json /app/
+RUN npm install --omit=dev
+
+# install serve entrypoint
+RUN npm install --omit=dev serve@14.2.4
+
+###################
+# third-party stage
+###################
+FROM base AS licenses
+
+USER node
 WORKDIR /app
 
-ADD package.json /app
-ADD package-lock.json /app
+RUN npm install license-checker@25.0.1
+RUN npx license-checker --production --json > licenses.json
+ADD --chown=node:node https://raw.githubusercontent.com/xronos-inc/node-third-party-licenses/refs/tags/v1.0.0/third-party-licenses.js /app/
+RUN node third-party-licenses.js licenses.json
 
-RUN npm install
+###################
+# app stage
+###################
+FROM ${BASEIMAGE} AS app
+ARG BUILDKIT_SBOM_SCAN_STAGE=true
+
+USER node
+WORKDIR /app
+RUN chown node:node /app
 
-COPY ./ /app
+# copy app
+COPY --from=base --chown=node:node /app/ /app/
 
-RUN npm run build --production
+# copy licenses
+COPY --from=licenses --chown=node:node /app/THIRD_PARTY_LICENSES.md /app/
+COPY --from=licenses --chown=node:node /app/third-party-licenses /app/third-party-licenses
+COPY --chown=node:node LICENSE /app/
 
-RUN npm install -g serve
-CMD serve -s build
+# build application
+COPY --chown=node:node public /app/public
+COPY --chown=node:node src /app/src
+COPY --chown=node:node .env /app/
+COPY --chown=node:node tailwind.config.js /app/
+COPY --chown=node:node tsconfig.json /app/
+ENV NODE_ENV=production
+RUN npm run build --omit=dev
 
 EXPOSE 3000
+ENTRYPOINT ["npm", "exec", "serve", "-s", "build"]

client/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Yuqi Huai (UCI SORA)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.