update docker and documentation

Author: pawel-baran-se

assets/XitasoLogo.svg

@@ -0,0 +1,37 @@
+networks:
+  mnestix-network:
+    driver: bridge
+    name: mnestix-network
+
+services:
+  mnestix-proxy:
+    container_name: mnestix-proxy
+    image: mnestix-proxy:dev
+    build:
+      dockerfile: Dockerfile
+    ports:
+      - '5065:5065'
+
+  mnestix-api:
+    ports:
+      - '5064:5064'
+
+  aas-environment:
+    ports:
+      - '8081:8081'
+
+  mongodb:
+    ports:
+      - '27017:27017'
+
+  aas-discovery:
+    ports:
+      - '8082:8081'
+
+  aas-registry:
+    ports:
+      - '8083:8080'
+
+  submodel-registry:
+    ports:
+      - '8084:8080'

assets/XitasoLogoBlack.svg

@@ -6,9 +6,7 @@
 services:
   mnestix-proxy:
     container_name: mnestix-proxy
-    image: mnestix-proxy:0.1.0
-    build:
-      dockerfile: Dockerfile
+    image: mnestix/mnestix-proxy:0.1.0
     ports:
       - '5065:5065'
     environment:
@@ -37,11 +35,9 @@ services:
       - mnestix-network
 
   mnestix-api:
-    image: mnestix/mnestix-api:1.3.2
+    image: mnestix/mnestix-api:1.3.4
     container_name: mnestix-api
     profiles: ['', 'backend', 'tests']
-    ports:
-      - '5064:5064'
     environment:
       ServerUrls ServerUrls: 'http://mnestix-proxy:5065/repo/'
       # API key authorization
@@ -78,7 +74,7 @@ services:
       - mnestix-network
 
   mongodb:
-    image: mongo:5
+    image: mongo:8
     container_name: mongodb
     profiles: ['', 'basyx', 'tests']
     environment:
@@ -99,13 +95,11 @@ services:
       - mnestix-network
 
   aas-environment:
-    image: eclipsebasyx/aas-environment:2.0.0-milestone-05
+    image: eclipsebasyx/aas-environment:2.0.0-milestone-06
     container_name: aas-environment
     profiles: ['', 'basyx', 'tests']
     depends_on:
       - mongodb
-    ports:
-      - '8081:8081'
     environment:
       # MongoDb configuration for Basyx Repository
       BASYX__BACKEND: MongoDB
@@ -133,7 +127,7 @@ services:
       - mnestix-network
 
   aas-discovery:
-    image: eclipsebasyx/aas-discovery:2.0.0-milestone-05
+    image: eclipsebasyx/aas-discovery:2.0.0-milestone-06
     container_name: aas-discovery
     profiles: ['', 'basyx', 'tests']
     depends_on:
@@ -161,11 +155,9 @@ services:
       - mnestix-network
 
   aas-registry:
-    image: eclipsebasyx/aas-registry-log-mongodb:2.0.0-milestone-05
+    image: eclipsebasyx/aas-registry-log-mongodb:2.0.0-milestone-06
     container_name: aas-registry
     profiles: ['', 'basyx']
-    ports:
-      - '8083:8080'
     depends_on:
       - mongodb
     environment:
@@ -181,11 +173,9 @@ services:
       - mnestix-network
 
   submodel-registry:
-    image: eclipsebasyx/submodel-registry-log-mongodb:2.0.0-milestone-05
+    image: eclipsebasyx/submodel-registry-log-mongodb:2.0.0-milestone-06
     container_name: submodel-registry
     profiles: ['', 'basyx']
-    ports:
-      - '8084:8080'
     depends_on:
       - mongodb
     environment:

assets/android-chrome-192x192.png

@@ -0,0 +1,109 @@
+# Docker Compose Setup for mnestix-proxy
+
+This guide explains how to use Docker Compose to run the full Mnestix Proxy stack, including the proxy, API, AAS environment, discovery, registry, and MongoDB.
+
+---
+
+## Compose Files
+
+- **compose.yml**: For production or standard usage. Uses pre-built images.
+- **compose.dev.yml**: For development. Builds the `mnestix-proxy` image from your local source.
+
+---
+
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) installed
+- [Docker Compose](https://docs.docker.com/compose/install/) (or use `docker compose` command with Docker Desktop)
+
+---
+
+## Usage
+
+### 1. Standard Setup
+
+From the project root, run:
+
+```sh
+docker compose up
+```
+
+This will start all services using pre-built images.
+
+### 2. Development Setup
+
+To build and run the proxy from your local source (using `compose.dev.yml`):
+
+```sh
+docker compose -f compose.yml -f compose.dev.yml up --build
+```
+
+This will build the `mnestix-proxy` image from your local Dockerfile and start all services. The development compose file also exposes all service ports for easier debugging.
+
+---
+
+## Services Overview
+
+- **mnestix-proxy**: Main reverse proxy gateway (`5065:5065`)
+- **mnestix-api**: Backend API service (`5064:5064`)
+- **mongodb**: MongoDB database for AAS and discovery services (`27017:27017`)
+- **aas-environment**: Eclipse BaSyx AAS environment (repository) (`8081:8081`)
+- **aas-discovery**: Eclipse BaSyx AAS discovery service (`8082:8081`)
+- **aas-registry**: Eclipse BaSyx AAS registry (`8083:8080`)
+- **submodel-registry**: Eclipse BaSyx submodel registry (`8084:8080`)
+
+All services are connected via the `mnestix-network` Docker network.
+
+---
+
+## Accessing Services
+
+- **Proxy**: [http://localhost:5065](http://localhost:5065)
+- **API**: [http://localhost:5064](http://localhost:5064)
+- **AAS Environment**: [http://localhost:8081](http://localhost:8081)
+- **AAS Discovery**: [http://localhost:8082](http://localhost:8082)
+- **AAS Registry**: [http://localhost:8083](http://localhost:8083)
+- **Submodel Registry**: [http://localhost:8084](http://localhost:8084)
+- **MongoDB**: [localhost:27017](http://localhost:27017)
+
+---
+
+## Environment Variables
+
+You can override default settings using environment variables, e.g.:
+- `MNESTIX_BACKEND_API_KEY`: API key for secured endpoints
+
+See `compose.yml` and `compose.dev.yml` for all configurable variables.
+
+---
+
+## Stopping the Stack
+
+To stop and remove all containers:
+
+```sh
+docker compose down
+```
+
+---
+
+## Troubleshooting
+
+- View logs: `docker compose logs`
+- Check health status: Services use health checks to ensure readiness.
+- Make sure required ports are available and not blocked.
+
+---
+
+## Customization
+
+- Edit `compose.yml` or `compose.dev.yml` to change ports, images, or environment variables.
+- Update `mnestix-proxy/appsettings.json` for proxy configuration.
+
+---
+
+## References
+
+- [compose.yml](../compose.yml)
+- [compose.dev.yml](../compose.dev.yml)
+- [mnestix-proxy/appsettings.json](../mnestix-proxy/appsettings.json)

compose.dev.yml

@@ -0,0 +1,68 @@
+# Getting Started with Developing mnestix-proxy
+
+## Prerequisites
+
+Before you start developing with **mnestix-proxy**, ensure you have the following installed:
+
+- **.NET 8 SDK** (required for building and running the project)
+- **Git** (for version control)
+- **Visual Studio Code** or **JetBrains Rider** (recommended IDEs)
+- **Docker** (optional, for containerized development and testing)
+
+## Project Structure
+
+The main source code is located in the `mnestix-proxy` folder. Key directories and files include:
+
+- `Program.cs` — Application entry point
+- `Authentication/` — Authentication logic and middleware
+- `Configuration/` — Configuration options and classes
+- `Exceptions/` — Custom exception types
+- `Middleware/` — Custom ASP.NET Core middleware
+- `Services/` — Service implementations and interfaces
+- `appsettings.json` / `appsettings.Development.json` — Configuration files
+- `.github/workflows/` — CI/CD workflows
+
+## Setup Instructions
+
+1. **Clone the repository:**
+   ```sh
+   git clone https://github.com/eclipse-mnestix/mnestix-proxy.git
+   cd mnestix-proxy/mnestix-proxy
+   ```
+
+2. **Install dependencies:**
+   - Make sure you have the [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) installed.
+
+3. **Configure environment variables:**
+   - Update `appsettings.Development.json` or `appsettings.json` as needed for your environment.
+
+4. **Run the development server:**
+   ```sh
+   dotnet run
+   ```
+
+5. **Run tests:**
+   ```sh
+   dotnet test
+   ```
+
+## Docker Development (Optional)
+
+- Build and run the project using Docker:
+  ```sh
+  docker build -t mnestix-proxy .
+  docker run -p 5000:5000 mnestix-proxy
+  ```
+- See `.dockerignore` and `docker-compose.yml` (if present) for details.
+
+## Additional Notes
+
+- Use `dotnet restore` if you encounter missing dependencies.
+- Pull the latest changes from the main branch before starting new work.
+
+## Useful Links
+
+- [.NET 8 SDK Download](https://dotnet.microsoft.com/download/dotnet/8.0)
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [JetBrains Rider](https://www.jetbrains.com/rider/)
+- [Git Download](https://git-scm.com/)

compose.yml

@@ -1 +1,18 @@
-Init page for Mnestix Proxy
+<p align="right">
+  <picture>
+    <source srcset="https://raw.githubusercontent.com/eclipse-mnestix/mnestix-proxy/main/assets/XitasoLogo.svg"  media="(prefers-color-scheme: dark)">
+    <img src="https://raw.githubusercontent.com/eclipse-mnestix/mnestix-proxy/main/assets/XitasoLogoBlack.svg" width=20%>
+  </picture>
+</p>
+<p align="center">
+ <img src="https://raw.githubusercontent.com/eclipse-mnestix/mnestix-proxy/main/assets/android-chrome-192x192.png" alt="Mnestix Logo">
+</p>
+<h1 style="text-align: center">Mnestix</h1>
+
+[![Made by XITASO](https://img.shields.io/badge/Made_by_XITASO-005962?style=flat-square)](https://xitaso.com/)
+[![MIT License](https://img.shields.io/badge/License-MIT-005962.svg?style=flat-square)](https://choosealicense.com/licenses/mit/)
+
+### Welcome to the Mnestix Community!
+
+**Mnestix Proxy** is an open-source gateway designed to securely and flexibly connect applications with Asset Administration Shell (AAS) data sources. Developed by XITASO, it enables routing of AAS API requests, to AAS repositories, discovery and registry services, supports use cases such as Digital Twins and Digital Product Passports (DPP).
+