Release v15.0.0

Release v15.0.0

Author: Alfagun74

CHANGELOG.md

@@ -1,5 +1,46 @@
 # GameVault Backend Server Changelog
 
+## 15.0.0
+
+### Breaking Changes & Migration
+
+- Completely Overhauled Authentication System -> **Update your GameVault Client Application. Clients older than 1.17.0.0 will no longer work with this version. If you use the API, make sure to consult the documentation to learn how to authenticate with this release.**
+- Renamed some environment variables -> **Update your environment variables if you rely on them.**
+  - `SEARCH_RECURSIVE` to `GAMES_SEARCH_RECURSIVE`
+  - `CONFIGURATION_STACK_TRACE_LIMIT` to `SERVER_STACK_TRACE_LIMIT`
+  The deprecated variables will be removed in **v16.0.0**.
+- [#6](https://github.com/Phalcode/gamevault-backend/issues/6) **Added support for OAuth 2.0 and SSO Logins.**
+- Moved `/api/health` to `/api/status` -> **Health API will be removed in v16.0.0.**
+- **Removed deprecated APIs**.
+
+### Changes
+
+- Users can now also login via email and password using the basic-auth login.
+- Added more information about registrations to the server in the `/api/status` endpoint.
+- Fixed IGDB Integration throwing 429s for servers with lots of games
+- Fixed some wrong data in the OpenAPI Specification
+- Optimized some synchronous tasks
+- [#500](https://github.com/Phalcode/gamevault-backend/issues/500) Implemented `installer_parameters`, `uninstaller_parameters`, and `uninstaller_executable` fields in game metadata.
+- [#502](https://github.com/Phalcode/gamevault-backend/issues/502) & [#344](https://github.com/Phalcode/gamevault-backend/issues/344) Implemented Default Innosetup & NSIS Installer Params for IGDB Provider
+- [#488](https://github.com/Phalcode/gamevault-app/issues/488) Fixed bug where users could not be registered without first and last name.
+- [#496](https://github.com/Phalcode/gamevault-app/issues/496) Fixed bug where manually edited early access games would not show up in the early access list.
+- Added `GAMES_INDEX_USE_POLLING` env var to enable filewatching of remote networks or docker for windows containers.
+- [#359](https://github.com/Phalcode/gamevault-app/issues/359) Implemented API-Key Authentication
+
+### Thanks
+
+- @Toylerrr
+
+## 14.1.2
+
+### Changes
+
+- Loosened some container internal permissions so non-root users can use plugins
+
+### Thanks
+
+- @HiImaWalrus
+
 ## 14.1.1
 
 ### Changes
@@ -581,18 +622,15 @@ Recommended Gamevault App Version: `v1.6.1.0`
 ### Breaking Changes & Migration
 
 - Case Insensitivity for Usernames and Emails:
-
   - Usernames and user emails are now treated as case-insensitive.
   - During the update to v7.0.0, a new database migration will check for users with conflicting usernames or emails caused by differences in letter casing.
   - If such conflicts are found, the migration will halt and report an error. This prevents the update to v7.0.0 until these conflicts are resolved.
   - Administrators are advised to revert to the previous GameVault version to address these conflicts and ensure a smooth transition to v7.0.0.
 
 - Performance Enhancement: Removal of Progress Details and Filters from /games API:
-
   - To further enhance performance, the /games API no longer includes progress details and filters.
 
 - Improved User Progress Handling:
-
   - User-related calls now include deleted game details in their progress information.
   - This enhancement allows for the correct display of progress even after a game has been deleted, ensuring a more comprehensive user experience.
 

Dockerfile

@@ -1,57 +1,87 @@
+# Use the official Node LTS slim image as the base
 FROM node:lts-slim AS base
 
-ENV TZ="Etc/UTC"
-ENV PUID=1000
-ENV PGID=1000
-ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
-ENV NPM_CONFIG_PREFIX=/home/node/.npm-global
-ENV PATH=$PATH:/home/node/.npm-global/bin
-ENV PNPM_HOME=/pnpm
-ENV PATH=$PNPM_HOME:$PATH
-ENV SERVER_PORT=8080
-ENV YES=yes
-
+# Set environment variables
+ENV TZ="Etc/UTC" \
+    PUID=1000 \
+    PGID=1000 \
+    PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
+    NPM_CONFIG_PREFIX=/home/node/.npm-global \
+    PNPM_HOME=/pnpm \
+    SERVER_PORT=8080 \
+    YES=yes \
+    PATH="/home/node/.npm-global/bin:/pnpm:$PATH"
+
+# Create necessary directories with appropriate permissions
 RUN mkdir -p /files /media /logs /db /plugins /savefiles \
-    && chown -R node:node /files /media /logs /db /plugins /savefiles \
-    && chmod -R 777 /files /media /logs /db /plugins /savefiles \
-    && sed -i -e's/ main/ main non-free non-free-firmware contrib/g' /etc/apt/sources.list.d/debian.sources \
+    # Enable non-free and contrib repositories for Debian-based package installations
+    && sed -i -e 's/ main/ main non-free non-free-firmware contrib/g' /etc/apt/sources.list.d/debian.sources \
+    # Update package list and install necessary dependencies
     && apt update \
-    && apt install -y curl p7zip-full p7zip-rar postgresql-common sudo \
+    && apt install -y --no-install-recommends \
+    build-essential \
+    curl \
+    g++ \
+    make \
+    p7zip-full \
+    p7zip-rar \
+    postgresql-common \
+    python-is-python3 \
+    python3 \
+    sudo \
+    # Install PostgreSQL client from the PostgreSQL Global Development Group (PGDG)
     && /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh \
-    && apt install -y postgresql-client \
-    && apt clean \
-    && npm i -g pnpm@^10.4.1
+    && apt install -y --no-install-recommends postgresql-client \
+    # Clean up to reduce image size
+    && apt clean && rm -rf /var/lib/apt/lists/* \
+    # Install PNPM package manager globally
+    && npm i -g pnpm@^10.12.1
 
+# Set working directory for the application
 WORKDIR /app
 
+# ---- Build Stage ----
 FROM base AS build
 
+# Copy dependency files and install dependencies
 COPY package.json pnpm-lock.yaml ./
 RUN pnpm install --frozen-lockfile
 
+# Copy application source code and build the project
 COPY . .
 RUN pnpm run build
 
+# ---- Production Dependencies Stage ----
 FROM base AS prod-deps
 
+# Copy dependency files and install only production dependencies
 COPY package.json pnpm-lock.yaml ./
 RUN pnpm install --prod --frozen-lockfile
 
+# ---- Release Stage ----
 FROM base AS release
 
+# Set the environment to production mode
 ENV NODE_ENV=production
 
+# Copy dependency files (ensuring same versions as build)
 COPY package.json pnpm-lock.yaml ./
 
+# Copy built application and production dependencies
 COPY --from=build --chown=node:node /app/dist ./dist
 COPY --from=prod-deps --chown=node:node /app/node_modules ./node_modules
+COPY --chown=node:node  entrypoint.sh /usr/local/bin/
 
-COPY entrypoint.sh /usr/local/bin/
-RUN chmod +x /usr/local/bin/entrypoint.sh
+RUN chown -R node:node /app/dist /files /media /logs /db /plugins /savefiles \
+    && chmod -R 777 /app/dist /files /media /logs /db /plugins /savefiles \
+    && chmod +x /usr/local/bin/entrypoint.sh
 
+# Expose the server port
 EXPOSE ${SERVER_PORT}/tcp
 
-HEALTHCHECK --start-period=300s CMD curl -f http://localhost:${SERVER_PORT}/api/health || exit
+# Add a health check for the service
+HEALTHCHECK --start-period=300s CMD curl -f http://localhost:${SERVER_PORT}/api/status || exit 1
 
+# Set entrypoint and default command
 ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
-CMD [ "dist/src/main" ]
+CMD ["dist/src/main"]

docker-compose.coolify.yml

@@ -0,0 +1,52 @@
+services:
+  gamevault-backend:
+    build: .
+    restart: unless-stopped
+    environment:
+      DB_HOST: db
+      DB_USERNAME: gamevault
+      DB_PASSWORD: ${DB_PASSWORD}
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8080/api/status"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+    volumes:
+      - type: bind
+        source: files
+        target: /files
+        is_directory: true
+      - type: bind
+        source: media
+        target: /media
+        is_directory: true
+      - type: bind
+        source: logs
+        target: /logs
+        is_directory: true
+      - type: bind
+        source: config
+        target: /config
+        is_directory: true
+      - type: bind
+        source: plugins
+        target: /plugins
+        is_directory: true
+      - type: bind
+        source: savefiles
+        target: /savefiles
+        is_directory: true
+
+  db:
+    image: postgres:16
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: gamevault
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_DB: gamevault
+    volumes:
+      - type: bind
+        source: databae
+        target: /var/lib/postgresql/data
+        is_directory: true

entrypoint.sh

@@ -9,16 +9,28 @@ echo "#   ╚═════╝ ╚═╝  ╚═╝╚═╝     ╚═╝╚
 echo "#                                                      developed by Phalcode    #"
 echo "#################################################################################"
 set -e
-# If running as root, it means the --user directive for Docker CLI/Compose was not used
-# Use then the PUID env to set the user and group IDs
-if [ "$(id -u)" = '0' ]; then
-    # Modify the group ID of the 'node' user to match the PGID environment variable
-    groupmod -o -g "$PGID" node
-    # Modify the user ID of the 'node' user to match the PUID environment variable
-    usermod -o -u "$PUID" node
-    # Run the specified command with the modified user and group IDs
-    sudo -u "#$PUID" -g "#$PGID" -E node "${@}"
+
+echo "Starting container with PUID=${PUID} and PGID=${PGID}"
+echo "Effective UID: $(id -u), GID: $(id -g)"
+
+# If running as root, adjust the "node" user to match PUID/PGID,
+# change ownership on directories, and drop privileges.
+if [ "$(id -u)" = "0" ]; then
+    # Adjust ownership and ensure permissions are open.
+    chown -R "${PUID}:${PGID}" /app/dist /files /media /logs /db /plugins /savefiles
+    chmod -R 775 /app/dist /files /media /logs /db /plugins /savefiles
+    
+    # Only update the node user's UID/GID if different from defaults.
+    if [ "${PUID}" != "1000" ] || [ "${PGID}" != "1000" ]; then
+        echo "Updating 'node' user to PUID: ${PUID} and PGID: ${PGID}"
+        groupmod -o -g "${PGID}" node
+        usermod -o -u "${PUID}" node
+    fi
+    
+    # Drop privileges and run the command.
+    exec sudo -u "#${PUID}" -g "#${PGID}" -E node "$@"
 else
-    # If using the user directive, run the specified command normally
-    exec node "${@}"
+    # If running as non-root (e.g. using docker-compose "user:"), rely on open permissions.
+    echo "Running as non-root user: $(id -u)"
+    exec node "$@"
 fi