Release 2.5.0

Author: actions-user

.env.example

@@ -56,7 +56,7 @@ APP_FALLBACK_LOCALE="en_US"
 APP_FAKER_LOCALE="de_DE"
 
 APP_KEY=
-APP_PREVIOS_KEYS=
+APP_PREVIOUS_KEYS=
 
 APP_MAINTENANCE_DRIVER="cache"
 APP_MAINTENANCE_STORE="database"
@@ -168,7 +168,7 @@ OPEN_WEB_UI_API_KEY=
 # GWDG_FILE_CONVERTER_API_URL       URL to the GWDG converter. 'https://chat-ai.academiccloud.de/v1/documents/convert'
 
 FILE_CONVERTER=hawki_converter
-HAWKI_FILE_CONVERTER_API_URL=127.0.0.1:8001/extract
+HAWKI_FILE_CONVERTER_API_URL=127.0.0.1/extract
 HAWKI_FILE_CONVERTER_API_KEY=
 GWDG_FILE_CONVERTER_API_URL='https://chat-ai.academiccloud.de/v1/documents/convert'
 
@@ -309,6 +309,30 @@ SFTP_USERNAME=
 SFTP_PASSWORD=
 SFTP_BASE_PATH=
 
+# ===========================
+# File Upload Settings
+# ===========================
+#
+# The following settings define the limits and allowed types for file uploads in HAWKI. These settings are crucial for ensuring that the application can handle
+# file uploads securely and efficiently, while also providing a good user experience.
+#
+# IMPORTANT! Your upload limits must be supported by your PHP configuration (e.g. post_max_size and upload_max_filesize in php.ini).
+# If you set a file size limit that exceeds your PHP configuration, the limits will automatically be reduced to the maximum allowed by PHP, which may lead to confusion
+# if you are not aware of this behavior. Always ensure that your PHP configuration supports the file size limits you set in these environment variables.
+# If you are using our Docker image: Use the "MAX_UPLOAD_SIZE" variable in the Docker configuration to set the PHP and Nginx limits accordingly.
+#
+# MAX_FILE_SIZE: The maximum file size for an uploaded file (e.g., attachment) in bytes. The default is 20 MB (20 * 1024 * 1024 bytes).
+# MAX_AVATAR_FILE_SIZE: The maximum file size for an avatar in bytes. The default is 2 MB (2 * 1024 * 1024 bytes).
+# ALLOWED_FILE_MIME_TYPES: A comma-separated list of allowed MIME types for uploaded files (e.g., "image/jpeg,image/png,application/pdf"). If empty, the defaults are defined in the file storage service.
+# ALLOWED_AVATAR_MIME_TYPES: A comma-separated list of allowed MIME types for uploaded avatars (e.g., "image/jpeg,image/png"). If empty, the defaults are defined in the avatar storage service.
+# MAX_ATTACHMENT_FILES: The maximum number of files that can be attached to a single message. Set to 0 for unlimited.
+
+#MAX_FILE_SIZE=20971520
+#MAX_AVATAR_FILE_SIZE=2097152
+#ALLOWED_FILE_MIME_TYPES=
+#ALLOWED_AVATAR_MIME_TYPES=
+#MAX_ATTACHMENT_FILES=0
+
 # ==================
 # Event Broadcasting
 # ==================
@@ -327,39 +351,79 @@ BROADCAST_DRIVER="reverb"
 # Reverb: Websocket Server
 # ========================
 #
-# For websocket connectivity Lavarel provides a special server called Reverb. This must be
+# For websocket connectivity Laravel provides a special server called Reverb. This must be
 # set up for HAWKI since many features rely on real-time communication via web sockets.
 #
-#  - REVERB_HOST:                 Hostname of the Reverb server (set to your top-level domain for production)
-#  - REVERB_PORT:                 Port number of the Reverb server (set to 443 for production)
-#  - REVERB_SERVER_HOST:          Hostname of the Reverb server (set to 0.0.0.0 for production)
-#  - REVERB_SERVER_PORT:          Port number of the Reverb server (set to 8080 for production)
-#  - REVERB_SCHEME:               Connection protocol for the Reverb server: "http" or "https"
-#  - REVERB_APP_ID:               Reverb application Id, can be anything you like?
-#  - REVERB_APP_SECRET:           Password to access the Reverb server???
-#  - REVERB_APP_KEY:              Secret key to access the Reverb server ???
-#  - REVERB_APP_PING_INTERVAL:    Ping interval in seconds ???
-#  - REVERB_APP_MAX_MESSAGE_SIZE: Maximum message size in bytes ???
-#  - REVERB_SCALING_ENABLED:      "true" or "false"
-#  - REVERB_SCALING_CHANNEL:      "reverb"
-
-REVERB_SERVER="reverb"
-REVERB_HOST="127.0.0.1"
-REVERB_PORT="8080"
+# --- Server binding ---
+#
+#  - REVERB_SERVER_HOST: The network interface address Reverb binds to when it starts.
+#                        This should almost always be "0.0.0.0" so Reverb listens on all interfaces.
+#                        Only change this if you explicitly want to restrict which interface Reverb listens on.
+#  - REVERB_SERVER_PORT: The port Reverb listens on internally. Defaults to 8080.
+#
+# --- Backend connection (PHP → Reverb) ---
+#
+# These variables tell the PHP application how to reach the Reverb server internally.
+# They are NOT used by the browser and do NOT need to be publicly accessible.
+# In a typical Docker or local setup, Reverb runs on the same host as PHP.
+#
+#  - REVERB_HOST:   Hostname the PHP application uses to connect to Reverb internally.
+#  - REVERB_PORT:   Port the PHP application uses to connect to Reverb internally.
+#  - REVERB_SCHEME: Protocol used for the internal PHP → Reverb connection: "http" or "https".
+#                   Use "http" unless Reverb itself is terminating TLS.
+#
+# --- Frontend connection override ---
+#
+# By default, the browser assumes Reverb is accessible via the same host and port as APP_URL,
+# i.e. it expects a reverse proxy to forward WebSocket traffic to Reverb. If your setup differs
+# (e.g. Reverb is exposed on a different host or port), you can override the frontend connection:
+#
+#  - VITE_REVERB_HOST: Hostname the browser uses to connect to Reverb. Defaults to APP_URL host.
+#  - VITE_REVERB_PORT: Port the browser uses to connect to Reverb. Defaults to APP_URL port.
+#  - VITE_REVERB_SCHEME: Protocol used by the browser to connect to Reverb: "https" or "http".
+#
+#  --> If you don't have any issues, keep those values commented out.
+#
+# --- Application identity and security ---
+#
+#  - REVERB_APP_ID:     Uniquely identifies this WebSocket application instance on the Reverb server.
+#                       Useful when multiple applications share one Reverb server.
+#                       Can be a number (e.g. "1001") or a string (e.g. "hawki").
+#  - REVERB_APP_KEY:    A public identifier used to establish a WebSocket connection with Reverb.
+#                       This value is also exposed to the browser (frontend) to initiate the connection.
+#  - REVERB_APP_SECRET: A shared secret key used by the backend to authenticate with the Reverb server
+#                       and to sign/validate real-time events. Must be kept private. Required.
+#
+# --- Behaviour ---
+#
+#  - REVERB_APP_PING_INTERVAL:    How often (in seconds) the backend pings connected frontend clients
+#                                 to verify they are still alive. Defaults to 60.
+#  - REVERB_APP_MAX_MESSAGE_SIZE: Maximum WebSocket message size in bytes. Defaults to 250000 (≈244 KB).
+#
+# --- Scaling (advanced) ---
+#
+#  - REVERB_SCALING_ENABLED: Set to "true" to enable Redis-based scaling across multiple Reverb instances.
+#  - REVERB_SCALING_CHANNEL: Redis channel used for scaling coordination. Defaults to "reverb".
 
-# REVERB_SERVER_HOST= 0.0.0.0
-# REVERB_SERVER_PORT= 8080
+REVERB_SERVER_HOST="0.0.0.0"
+REVERB_SERVER_PORT="8080"
 
+REVERB_HOST="127.0.0.1"
+REVERB_PORT="8080"
 REVERB_SCHEME="http"
 
 REVERB_APP_ID="hawki"
-REVERB_APP_SECRET=
 REVERB_APP_KEY=
+REVERB_APP_SECRET=
+
+#VITE_REVERB_HOST=
+#VITE_REVERB_PORT=
+#VITE_REVERB_SCHEME=
 
-#REVERB_APP_PING_INTERVAL    = 60
 REVERB_APP_MAX_MESSAGE_SIZE="250000"
-#REVERB_SCALING_ENABLED      = false
-#REVERB_SCALING_CHANNEL      = reverb
+#REVERB_APP_PING_INTERVAL=60
+#REVERB_SCALING_ENABLED=false
+#REVERB_SCALING_CHANNEL=reverb
 
 # =================================
 # SSL Certificate Configuration
@@ -384,39 +448,6 @@ REVERB_APP_MAX_MESSAGE_SIZE="250000"
 SSL_CERTIFICATE=""
 SSL_CERTIFICATE_KEY=""
 
-# ===========================
-# Vite Environment Configuration
-# ===========================
-#
-# These Vite environment variables are used to configure the front-end build system
-# and its integration with services such as Reverb for real-time functionality within
-# the application.
-#
-# VITE_APP_NAME: Represents the application's name used within the Vite build process.
-# It is typically a direct reflection of the application's name set in the Laravel backend.
-#
-# VITE_REVERB_APP_KEY: The Reverb application's key used for authentication. It should
-# mirror the REVERB_APP_KEY variable set in the backend environment configuration.
-#
-# VITE_REVERB_APP_CLUSTER: The cluster designation for the Reverb setup, which specifies
-# which region or data center the real-time data will be managed through.
-#
-# VITE_REVERB_HOST: Designates the host for the Reverb service. This is typically set
-# from the corresponding backend environment variable REVERB_HOST.
-#
-# VITE_REVERB_PORT: Specifies the port that the Reverb service will run on, consistent
-# with the setup from the backend environment variable REVERB_PORT.
-#
-# VITE_REVERB_SCHEME: Defines the protocol scheme used by the Reverb service, such as
-# "http" or "https", typically mirroring the REVERB_SCHEME variable from the backend.
-
-VITE_APP_NAME="${APP_NAME}"
-VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
-VITE_REVERB_APP_CLUSTER="your_cluster"
-VITE_REVERB_HOST="${REVERB_HOST}"
-VITE_REVERB_PORT="${REVERB_PORT}"
-VITE_REVERB_SCHEME="${REVERB_SCHEME}"
-
 # ===========================
 # Queue Worker Configuration
 # ===========================