From 34af8c99a1708116de9905dc0994f902809c177d Mon Sep 17 00:00:00 2001 From: chris-admin Date: Wed, 2 Jul 2025 20:51:06 +0200 Subject: [PATCH] Update URGENT --- URGENT.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/URGENT.md b/URGENT.md index bf4b10c..be2f5be 100644 --- a/URGENT.md +++ b/URGENT.md @@ -1 +1,47 @@ -# Urgent \ No newline at end of file +# Urgent + +## Integration with Nginx configurations + +> [!TIP] +> files under: +> - `src/lib/server/classes/endpoints/` are to be exposed to the App +> - `src/lib/server/broker-utils/FileSystem/` are to brokers that interact with the DB + +As for now, there's the scaffolding to create SSL-Termination endpoints, +so technically speaking, we just need a way to write those on the DB +and create them + +However these are the ***IDEAL*** steps we should take + +### `Manual` class + +> [!CAUTION] +> These endpoints may have been generated to address some shortcomings of this +> project, so ***NEVER DELETE*** them + +This class if for `endpoints` found without any generated headers, so it's not possible +to parse them. Probably they have been generated by users while configuring something custom. + +These may crash our program due to the inability to parse them + +#### How to implement these + +> [!TIP] +> When in doubt, take a look at ssltermination files in the corresponding `directories` + +- create a file in `src/lib/server/classes/endpoints/` for the class `Manual` + - create a `class Manual implements IEndpoint` + - create a `class ManualEndpointApp` + - create an `interface IManualBroker` +- create a file in `src/lib/server/broker-utils/FileSystem/endpoints/` for the class `ManualFS` + - create a `class ManualFS implements IEndpointFS` +- create a file in `src/lib/server/broker-utils/FileSystem/endpoints/` for the class `ManualBrokerFS` + - create a `class ManualBrokerFS implements IManualBroker` + +This class must contain all the text of the `*.conf` file + +### `Endpoint` class + +This class handles all the logic for transactions with the FS. +there are utils for Filesystem interactions found in `src/server/lib/utils/filesystem-utils.ts`, +please use them if possible and add new functionalities if needed \ No newline at end of file