Merge branch 'master' into PHRAS-4146-abort-app-install-if-not-empty

Author: nmaillat

.dockerignore

@@ -38,3 +38,4 @@
 /www/thumbnails
 /www/.htaccess
 npm-debug.log
+stack_management.sh

.env

@@ -154,7 +154,7 @@ PHRASEANET_DOCKER_REGISTRY=alchemyfr
 
 # Docker images tag.
 # @run
-PHRASEANET_DOCKER_TAG=4.1.17
+PHRASEANET_DOCKER_TAG=4.1.18
 
 # Stack Name
 # An optionnal Name for the stack
@@ -278,6 +278,9 @@ RABBITMQ_MANAGEMENT_PORT=10811
 # @run
 RABBITMQ_HOSTNAME=rabbit_phraseanet
 
+# @run
+RABBITMQ_IMAGE_VERSION=rabbitmq:4.1.0-management
+
 # --- Gateway settings (Nginx) -----------------------------------------------------------------------------------------
 
 # Value applied to "send_timeout", "keepalive_timeout", "client_header_timeout"
@@ -672,7 +675,7 @@ PHRASEANET_APP_PORT=8082
 PHRASEANET_ADMIN_ACCOUNT_ID=
 
 # @run
-PHRASEANET_ADMIN_ACCOUNT_EMAIL=admin@alchemy.fr
+PHRASEANET_ADMIN_ACCOUNT_EMAIL=admin@phraseanet.local
 
 # require to be change for securitie reasons
 # @run

CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## 4.1.18
+
+#### Phraseanet Upgrade
+
+- **Phraseanet Migration Patch**:
+  - A migration script for the configuration file is available. Run the following command in the setup container with Docker if the environment variable `PHRASEANET_UPGRADE=1` is set:
+    ```
+    bin/setup system:upgrade
+    ```
+
+
+### Stack (Docker Compose and Helm)
+
+- no change
+
+### Version Summary
+
+- Installation process (bin/setup system:install) now aborts if the application and/or databox contain existing data. the option -f  also answer all questions for yes AND  force installation to continue even if DB table  already exist
+
+## What's Changed
+* PHRAS-4146 bin/setup system:install - abort app installation if mysql db is not empty by @aynsix in https://github.com/alchemy-fr/Phraseanet/pull/4599
+
+
+**Full Changelog**: https://github.com/alchemy-fr/Phraseanet/compare/4.1.17...4.1.18
+
+__
 ## 4.1.17
 
 #### Phraseanet Upgrade
@@ -37,7 +63,7 @@
 
 **Full Changelog**: https://github.com/alchemy-fr/Phraseanet/compare/4.1.16...4.1.17
 
-
+__
 ## 4.1.16
 
 ### Update Instructions
@@ -111,6 +137,7 @@ The provided MariaDB container in the Docker Compose stack is not ready for prod
 
 **Full Changelog**: https://github.com/alchemy-fr/Phraseanet/compare/4.1.15...4.1.16
 
+__
 ## 4.1.15
 
 ### Update Instructions

README.md

@@ -97,7 +97,8 @@ Get official support : https://www.alchemy.fr/en/rubrique/services/
 ## Prerequisites
 
 
-- docker >=v20.10.24
+- docker >=25.0.5
+- docker compose >= 2.29.0
 
 In the stack Docker, Docker Compose included in this repo starts by default in test mode. 
 All services are launched in a separate container and except "Phraseanet app" and "workers" containers, 
@@ -185,7 +186,7 @@ COMPOSE_PROFILES=app,gateway-classic,db,pma,elasticsearch,redis,redis-session,ra
 
 
 You should review the default env variables defined in `.env` file.
-Use `export` method to override these values.
+Use `export` method to override these values 
 
 i.e:
 ```bash
@@ -194,9 +195,28 @@ export [email protected]
 export INSTALL_ACCOUNT_PASSWORD=$3cr3t!
 export PHRASEANET_APP_PORT=8082
 ```
+
+If you want persit this change you can also save your change in a files named `env.local` or `.env.local`
+this files are git ignored and permit a stack customisation without git conflic generation
+see more about in stack management section 
+
 If you are not interested in the development of Phraseanet, you can ignore everything in `.env` after the `DEV Purpose` part.
 
 
+### stack Management
+ 
+To start and stop the stack, use the `stack_management.sh start|stop|info|check|log` script at the project root.
+this script work only Linux and MacOS.
+
+This script wrapping standard oprations for the stack, using standard docker compose cmd and take in account `.env` and `env.local | .env.local`  files.
+
+The `stop` operation is the most critical function of the script, as it ensures a clean shutdown 
+of the database container before stopping the entire stack.
+
+This script is useful if you are using the database container within the stack.
+
+Of course before using it you need to chmod this file.
+
 ### Using a env.local method for custom .env values
 
 It may be easier to deal with a local file to manage our env variables.

doc/API_documentation/v3/_compiled.yaml

@@ -400,10 +400,36 @@ paths:
 
         ### results.records.technical_informations
         always included
-
+          
         _nb:_ since stories are not related to a document, there is no technical_informations for stories.
-
-        ### results.records.children
+            
+        ### results.records.stories
+        Include a list of stories that contains the record
+          
+        stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
+        ```
+        "response": {
+          "results": {
+            "records": [
+              {
+                "stories": [
+                  {
+                    "story_id": 100
+                  },
+                  {
+                    "story_id": 102
+                  },
+                  ...
+                ],
+                ...
+              },
+              ...
+            ]
+          }
+        }
+        ```
+          
+        ### results.stories.children
         In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
 
         children is an array of records, with same structure as a result record.

doc/API_documentation/v3/api.yaml

@@ -443,10 +443,36 @@ paths:
 
         ### results.records.technical_informations
         always included
-
+          
         _nb:_ since stories are not related to a document, there is no technical_informations for stories.
-
-        ### results.records.children
+            
+        ### results.records.stories
+        Include a list of stories that contains the record
+          
+        stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
+        ```
+        "response": {
+          "results": {
+            "records": [
+              {
+                "stories": [
+                  {
+                    "story_id": 100
+                  },
+                  {
+                    "story_id": 102
+                  },
+                  ...
+                ],
+                ...
+              },
+              ...
+            ]
+          }
+        }
+        ```
+          
+        ### results.stories.children
         In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
 
         children is an array of records, with same structure as a result record.

doc/infra/compose/stack_management.md

@@ -0,0 +1,72 @@
+Certainly! Here's a README for the script that provides an overview of its functionality, usage, and features:
+
+---
+
+# Docker Stack Management Script
+
+This script is designed to manage a Docker stack, particularly for Phraseanet applications. It provides functionalities to start, stop, check, and gather information about the Docker stack, including version checks, log viewing, and environment details.
+
+## Features
+
+- **Start and Stop the Docker Stack**: Easily start or stop your Docker stack with simple commands.
+- **Version Checking**: Verify the compatibility of Docker and Docker Compose versions.
+- **Environment Information**: Gather detailed information about the environment, including Phraseanet installation status, version details, and internal URLs.
+- **Log Viewing**: View logs for all containers or filter logs for a specific container.
+- **Environment Variables**: Load and display environment variables from `.env` and either `env.local` or `.env.local` files.
+
+## Usage
+
+### Prerequisites
+
+- Docker and Docker Compose installed on your system.
+- Appropriate permissions to execute Docker commands.
+- Environment files (`.env`, `env.local`, or `.env.local`) configured with necessary variables.
+
+### Commands
+
+- **Start the Stack**:
+  ```bash
+  ./manage_docker.sh start
+  ```
+
+- **Stop the Stack**:
+  ```bash
+  ./manage_docker.sh stop
+  ```
+
+- **Check Versions**:
+  ```bash
+  ./manage_docker.sh check
+  ```
+
+- **Display Environment Information**:
+  ```bash
+  ./manage_docker.sh info
+  ```
+
+- **View Logs**:
+  - For all containers:
+    ```bash
+    ./manage_docker.sh log
+    ```
+  - For a specific container:
+    ```bash
+    ./manage_docker.sh log <container_name>
+    ```
+
+### Environment Variables
+
+The script uses the following environment variables, which should be defined in your environment files:
+
+- `PHRASEANET_DOCKER_TAG`: The Docker tag for the Phraseanet image.
+- `PHRASEANET_DOCKER_REGISTRY`: The Docker registry for the Phraseanet image.
+- `PHRASEANET_HOSTNAME`: The hostname for the Phraseanet instance.
+- `PHRASEANET_SCHEME`: The scheme (e.g., `http` or `https`) for the Phraseanet instance.
+- `PHRASEANET_APP_PORT`: The port for the Phraseanet application.
+
+### Notes
+
+- Ensure that the environment files (`.env`, `env.local`, or `.env.local`) are correctly configured with the necessary variables.
+- The script checks for the presence of `config/configuration.yml` to determine if Phraseanet is installed.
+- The script constructs the internal URL of the Phraseanet instance using the environment variables `PHRASEANET_HOSTNAME`, `PHRASEANET_SCHEME`, and `PHRASEANET_APP_PORT`.
+

docker-compose.altenatives.yml

@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
 
   db:

docker-compose.datastores.yml

@@ -1,5 +1,3 @@
-version: "3.9"
-
 services: 
   db:
     image: $PHRASEANET_DOCKER_REGISTRY/phraseanet-db:$PHRASEANET_DOCKER_TAG
@@ -24,7 +22,7 @@ services:
       - internal
 
   rabbitmq:
-    image: rabbitmq:3.8.34-management
+    image: $RABBITMQ_IMAGE_VERSION
     profiles: ["rabbitmq"]
     restart: on-failure
     hostname: $RABBITMQ_HOSTNAME

docker-compose.limits.yml

@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
   gateway:
     deploy: