mORMot Open Source

The docs/ folder in the latest mORMot2 commit already include those two units:

● Both units are documented in the mORMot2-SAD documentation. Here's the summary:

  mormot.app.daemon.pas

  Documented in:
  - Chapter 03 (line 366): Listed in the unit table as "Daemon/service support"
  - Chapter 20 (line 198): Used in code examples for daemon creation
  - Chapter 26 (line 150, 548): Mentioned in the architecture overview and deployment section for Windows service deployment

  The documentation covers cross-platform daemon/service functionality - the same code can run as a console application, Windows service, or Linux daemon.

  mormot.app.agl.pas (Angelize)

  Documented in:
  - Chapter 03 (line 367): Listed as "Application Graphics Layer" (note: the alignment report questions this description)
  - Chapter 20 (section 20.5, starting line 356): Comprehensive documentation of TSynAngelize as mORMot's cross-platform process manager

  Chapter 20.5 "Process Manager (Angelize)" provides the most detailed coverage:
  - Describes TSynAngelize as similar to NSSM (Windows) or supervisord (Linux)
  - JSON-configured and integrated with the daemon framework
  - Includes architecture diagrams, code examples, and a feature comparison table with NSSM, supervisord, and systemd

I can expand the documentation to cover this report, and send it for your consideration, if you wish:

mORMot2 Undocumented Features Report

Generated: 2025-12-18
Scope: Comprehensive analysis of mORMot 2.0-2.3 features
Method: Comparison of SAD documentation vs 129 source units and 14 internal CLAUDE.md files
Total Features Analyzed: 20

Executive Summary

The mORMot2 SAD was adapted from mORMot1 documentation. While existing content is accurate (100% alignment verified), 20 features lack substantive documentation.

Priority Distribution

• HIGH (4): IDocList, OpenAPI Generator, ACME, LDAP

• MEDIUM (5): Async HTTP, Relay/Tunnel, RSA, PKCS#11, Windows Security

• LOW (11): PDF, Reports, Compression, 7-Zip, PE/COFF, etc.

Top 5 Most Important

1. HIGH - ACME/Let's Encrypt - MENTION_ONLY - Medium effort

2. HIGH - LDAP Client - MENTION_ONLY - Medium effort

3. HIGH - OpenAPI Client Generator - MISSING - Medium effort

4. HIGH - IDocList/IDocDict - MENTION_ONLY - Small effort

5. MEDIUM - WebSocket Relay/Tunnel - MENTION_ONLY - Medium effort

Feature Analysis

1. ACME/Let's Encrypt Native Support

Status: MENTION_ONLY
Priority: HIGH
Source: src/net/mormot.net.acme.pas
Internal Docs: src/net/CLAUDE.md

What's in SAD

• Chapter 01: Listed as feature ("ACME/Let's Encrypt - Automatic TLS certificate management")

• Chapter 03: Listed in units table (mormot.net.acme | ACME/Let's Encrypt)

• Chapter 20.6.3: Only documents external certbot, NOT native mORMot support

What's Missing

// Key classes NOT documented:
TAcmeClient          // Main ACME v2 client class
TJwsHttpClient       // JWS HTTP client for ACME protocol
TAcmeChallenge       // HTTP-01 challenge structure
TOnAcmeChallenge     // Callback for challenge handling
THttpFullServer      // HTTP server with built-in ACME support

// Constants:
ACME_LETSENCRYPT_URL       // Production Let's Encrypt
ACME_LETSENCRYPT_DEBUG_URL // Staging/testing
ACME_ZEROSSL_URL           // ZeroSSL alternative

Impact: Developers don't know mORMot can automatically obtain TLS certificates without external tools like certbot.

---

2. LDAP Client

Status: MENTION_ONLY
Priority: HIGH
Source: src/net/mormot.net.ldap.pas
Internal Docs: src/net/CLAUDE.md

What's in SAD

• Chapter 03: Listed in units table (mormot.net.ldap | LDAP client)

• Chapter 21: Fictitious references to GetUserIdFromLDAP() (doesn't exist)

What's Missing

// Key classes NOT documented:
TLdapClient           // Main LDAP client class
TLdapCheckMember      // Group membership verification
TCldapDomainInfo      // Domain info via CLDAP

// Key functions:
CldapGetDomainInfo()  // Query domain controller
function LdapAuth()   // HTTP BASIC auth via LDAP

// Constants:
LDAP_PORT = '389'
LDAP_TLS_PORT = '636'

Impact: Developers can't leverage mORMot's native LDAP client for Active Directory integration.

---

3. OpenAPI Client Generator

Status: MISSING (SAD documents export, not import)
Priority: HIGH
Source: src/net/mormot.net.openapi.pas
Blog Post: Swagger/OpenAPI Client Generator

What's in SAD

• Chapter 17.5: Documents generating OpenAPI spec FROM mORMot services (export)

• Does NOT document consuming external OpenAPI specs to generate clients (import)

What's Missing

// Key classes NOT documented:
TOpenApiParser        // Parse OpenAPI 3.x / Swagger 2 specs
TOpenApiVersion       // oav2 (Swagger), oav3 (OpenAPI 3.x)
TOpenApiSchema        // Schema definition wrapper

// Usage pattern (NOT documented):
var
  Parser: TOpenApiParser;
begin
  Parser := TOpenApiParser.Create;
  Parser.ParseFile('api-spec.json');
  Parser.GeneratePascalUnit('GeneratedClient.pas');
end;

Impact: This is a major productivity feature added in v2.3 - developers can consume any REST API with generated type-safe clients.

---

4. IDocList / IDocDict Interfaces

Status: MENTION_ONLY
Priority: HIGH
Source: src/core/mormot.core.variants.pas
Blog Post: Easy JSON with Delphi and FPC

What's in SAD

• Chapter 04.5: Extensive TDocVariant/TDocVariantData documentation

• Chapter 04 table: Mentions IDocDict, IDocList without explanation

• NO examples or usage patterns for the interfaces

What's Missing

// Modern interface-based access (NOT documented):
var
  List: IDocList;
  Dict: IDocDict;
begin
  // Automatic memory management via interfaces
  List := DocList('[1, 2, 3, "text"]');
  Dict := DocDict('{"name": "John", "age": 30}');

  // Safe iteration
  for item in List do
    WriteLn(item);

  // Direct access
  WriteLn(Dict['name']);  // 'John'
end;

Impact: Developers use verbose TDocVariantData patterns when cleaner IDocList/IDocDict is available.

---

5. Async HTTP Server (Direct Usage)

Status: PARTIAL
Priority: MEDIUM
Source: src/net/mormot.net.async.pas

What's Documented

• useHttpAsync mode for TRestHttpServer ✓

• Server mode comparison table ✓

What's Missing

// Direct HTTP server (NOT via TRestHttpServer):
THttpAsyncServer       // Event-driven HTTP server
TPollAsyncSockets      // Low-level async socket handling
THttpProxyServer       // HTTP proxy with caching

// Architecture details:
// - IOCP on Windows (USE_WINIOCP)
// - epoll on Linux, kqueue on BSD/macOS
// - Thread pool configuration

---

6. WebSocket Relay / Tunnel

Status: MENTION_ONLY
Priority: MEDIUM (high enterprise value!)
Source: src/net/mormot.net.relay.pas, src/net/mormot.net.tunnel.pas

What's in SAD

• Chapter 03: Listed in table (mormot.net.relay | Firewall traversal)

• NO documentation of how to use it

What's Missing (SIGNIFICANT FEATURE!)

                    RELAY ARCHITECTURE (from source code)

    +------------+           PUBLIC RELAY           PRIVATE RELAY
    | client 1   |---\    +----------------+    +----------------+
    +------------+    --->| encapsulation  |<-->| decapsulation  |
                          +----------------+    +----------------+
    +------------+    --->|                |    |                |---> ORM/SOA Server
    | client 2   |---/    +----------------+    +----------------+     (behind firewall)
    +------------+
         internet              simple Linux box        corporate LAN

Key classes:

• TPublicRelay - Public server (internet-facing)

• TPrivateRelay - Private client (inside firewall)

• TTunnelLocal - TCP/UDP port forwarding

Benefits:

• Access servers behind firewalls WITHOUT firewall changes

• Regular WebSocket connection (works through proxies)

• Built-in encryption (SynLZ + optional ECDHE)

---

7. Windows Security (SID/DACL/ACE/SDDL)

Status: NO_DOC
Priority: MEDIUM
Source: src/core/mormot.core.os.security.pas

What's Missing

// Cross-platform Windows security model implementation:
RawSid                    // Binary SID storage
TSid                      // SID structure
TSecurityDescriptor       // Full SD wrapper
SDDL parsing/generation   // Security Descriptor Definition Language

// Key features:
// - Parse/generate SIDs (S-1-5-21-...)
// - DACL/SACL manipulation
// - Conditional ACE expressions
// - Active Directory definitions
// - Kerberos KeyTab support

---

8. Native RSA Encryption

Status: MENTION_ONLY
Priority: MEDIUM
Source: src/crypt/mormot.crypt.rsa.pas

What's Missing

// Pure Pascal RSA implementation (no OpenSSL required):
TBigInt              // Big integer arithmetic
TRsaContext          // RSA computation context
TRsaPrivateKey       // Private key handling
TRsaPublicKey        // Public key handling

// Features NOT documented:
// - FIPS-level key generation
// - RSASSA-PKCS1-v1.5 signatures
// - RSASSA-PSS signatures
// - Key pair validation
// - Performance notes (slower than OpenSSL, fastest native Pascal)

---

9. PKCS#11 / HSM Support

Status: NO_DOC (single table mention)
Priority: MEDIUM
Source: src/crypt/mormot.crypt.pkcs11.pas

What's Missing

// Hardware Security Module integration:
ICryptCertPkcs11     // Certificate interface with HSM info
TPkcs11              // PKCS#11 library wrapper
TPkcs11Object        // Token object abstraction

// Key features:
// - Load certificates from HSM
// - Sign/verify using hardware keys
// - PIN management
// - Slot/token discovery
// - Integration with Cert()/Asym() factories

---

10-12. Lower Priority Features

10. DNS Client - mormot.net.dns.pas
Query any DNS record type (A, MX, SRV, TXT, etc.)

11. mget/THttpPeerCache - src/tools/mget/
HTTP downloader with P2P LAN cache, resume, hash verification

12. Command Line Parser - mormot.core.rtti.pas
RTTI-based argument parsing: SetObjectFromExecutableCommandLine()

---

13-20. Phase 2 Features (Low Priority)

13. PDF Generation Engine - mormot.ui.pdf.pas
TPdfDocument, PDF/A compliance, encryption, Uniscribe

14. Report Engine - mormot.ui.report.pas
TGdiPages with preview, print, PDF export

15. Compression (Lizard, Zstd) - mormot.lib.lizard.pas
TAlgoLizard: 1.8 GB/s decompression speed

16. 7-Zip Integration - mormot.lib.win7zip.pas
I7zReader/I7zWriter interfaces

17. PE/COFF Parser - mormot.misc.pecoff.pas
TSynPELoader: Cross-platform Windows executable analysis

18. ORM Grid Integration - mormot.ui.grid.orm.pas
TOrmTableToGrid: Bind ORM results to TDrawGrid

19. Console App Framework - mormot.app.console.pas
ICommandLine/TCommandLine with interactive prompting

20. Database Proxy - mormot.db.proxy.pas
Access databases through HTTP relay

Consolidated Summary - All Features by Priority

HIGH Priority:

1. IDocList/IDocDict - MENTION_ONLY - Small effort - Expand Ch 04.5

2. OpenAPI Client Generator - MISSING - Medium effort - New section Ch 17

3. ACME/Let's Encrypt - MENTION_ONLY - Medium effort - New section Ch 20

4. LDAP Client - MENTION_ONLY - Medium effort - New section Ch 21

MEDIUM Priority:

1. Async HTTP (direct) - PARTIAL - Medium effort - Expand Ch 11

2. WebSocket Relay/Tunnel - MENTION_ONLY - Medium effort - New section Ch 11/20

3. Native RSA - MENTION_ONLY - Medium effort - Expand Ch 23

4. PKCS#11/HSM - NO_DOC - Medium effort - New section Ch 23

5. Windows Security - NO_DOC - Medium effort - New section Ch 21

LOW Priority:

1. DNS Client - MENTION_ONLY - Small effort - Optional Ch 03

2. mget/PeerCache - NO_DOC - Small effort - Optional new section

3. Command Line Parser - NO_DOC - Small effort - Optional Ch 04

4. PDF Generation - MENTION_ONLY - Medium effort - New chapter/section

5. Report Engine - NO_DOC - Medium effort - New chapter/section

6. Compression (Lizard/Zstd) - MENTION_ONLY - Small effort - Expand Ch 03

7. 7-Zip Integration - MENTION_ONLY - Small effort - Optional

8. PE/COFF Parser - NO_DOC - Small effort - Optional

9. ORM Grid Integration - NO_DOC - Small effort - Optional

10. Console App Framework - NO_DOC - Small effort - Optional

11. Database Proxy - MENTION_ONLY - Small effort - Optional

Recommendations

Immediate Actions (High Impact, Low Effort)

• IDocList/IDocDict - Expand Chapter 04.5 (small effort, high value). Source: src/core/CLAUDE.md, blog post available

Short-Term Actions (High Impact)

• OpenAPI Generator - New section in Chapter 17 (blog post available)

• ACME/Let's Encrypt - New section in Chapter 20 or 21

• LDAP Client - New section in Chapter 21

Medium-Term Actions

• WebSocket Relay/Tunnel - New section (high enterprise value)

• Native RSA/X.509 - Expand Chapter 23

• PKCS#11/HSM - New section in Chapter 23

Information Sources

Internal CLAUDE.md - Detailed technical docs - src/*/CLAUDE.md (14 files)
Blog Posts - Feature announcements - blog.synopse.info
Source Comments - API documentation - *.pas files
Test Suite - Usage examples - /mnt/w/mORMot2/test/

Blog Posts to Reference:

• OpenAPI Generator (2024-09): Swagger/OpenAPI Client Generator

• IDocList/IDocDict (2024-02): Easy JSON with Delphi and FPC

• Native X.509/RSA (2023-12): Native X.509 and RSA Support

• mget/PeerCache (2024-01): Happy New Year 2024 and Welcome MGET

---

Report End

The .pro files are here: https://wp.cyber.es/mORMot2/pro_output.zip

the word options give me Access violation at address 0000000
The website export does not seem to do anything

IMO, that kind of simple examples is prefect for anyone approaching mORMot2; what for an expert is "just ..." for a newcomer is "ah, that's what I was looking for"

Sure, we can share hints, tips and findings if you wish
When I have access to my computer I'll arrange and share stuff

Thank you very much! It's extraordinarily difficult finding someone sharing AI coding stuff related to Delphi
I will load your skills

And I agree with you: Claude Code can handle mORMot2 extremely well, thanks to the great effort done by ab to structure and document all thoroughly

After 45 years of daily coding, these days 99% of the code I produce every day is through AI. Had you asked me one year ago if this was possible, I would have thought you were crazy.

The documentation updating from mORMot(1) to mORMot2 is 100% done with AI
The code examples are all compiled to be sure it's syntactically correct; even the snippets are enclosed in a fake project so it can be compiled

I'm using more mORMot2 now than before; yesterday just remade an MCP server I had made with the GDK MCP server, with mORMot2. The very excellent code documentation inlined everywhere in mORMot2 makes the AI understand it perfectly; way better than me.

In my mORMot2 copy, every folder has a CLAUDE.md documenting it, and then a main .md document with a global description and links to all the folder documents

Sure; I just made a Github GIST:
https://gist.github.com/JavierusTk/04ab … 47f7344ef8

The conditionals are the ones created by Delphi itself; I have mORMot2 repo cloned at W:\mORMot2, and my DPK stored elsewhere, so you'll need to replace my paths with yours
I've not included mormot.db.rad.nexusdb.pas, mormot.db.rad.bde.pas nor mormot.db.rad.firedac.pas, so it will not require the Delphi packages for BDE, NexusDB or FireDAC
I have Delphi Professional here, and I use UniDAC instead of FireDAC

The package has some time, so I propably have left outside a bunch of newer units, but as I don't use them, it's not a problem for me

Let me know if you have any problem

I have a big package with all the mormot2 units on it
I don't have any multithreading knowledge, and so don't know if the threadvars will work properly on a package. I suppose they will, but as I said, I can't really judge

So we can not compile mORMot2 as-is in a package and use it safely?

mORMot won't be ever on GetIt. It does something strictly forbidden: "adding Client Server technology to Professional"

However if it's split in smaller repos, building ones on top of the others, I believe a good part of it could be there. And that could lead those repo users to the whole mORMot 2

mORMot 2 has still not reached release status?

What would you mean by validating it?
Compiling and running the tests would be of any help at all?
I do have Delphi Professional installed and current, but as of today all my development is still D2007/Win32 focused. Working my way towards

Thank you! Now compiles fine

Yes, it was the first I tried, with same result: hangs

I download and compile mORMot2 repo almost every day; no problems so far; will report whenever I find any other trouble

Unfortunately, I can't change that

The much excellent "Calibre", it's an open source piece of art, a do-it-all tool to handle eBooks, from library handling to eBook reader sync

https://calibre-ebook.com

I browsed to the documentation page, and just downloaded it as plain html. Then droped the file on Calibre
Right clic on it, chose "Covert book",  and then the first option (don't know the english caption, but it's not the bulk one)
There I just chose one thing: on "Page Configuration" I chose "Kindle" in both "Input profile" and "output profile". It was a random decision; don't know if it's needed at all
And "OK"

There is a load of stuff you can customize, but I didn't use it

Delphi Help:
function LoadPackage(const Name: string): HMODULE; overload;
function LoadPackage(const Name: string; AValidatePackage: TValidatePackageProc): HMODULE; overload;

Ofcourse, I know I would get more speed and less resource usage.
So, you should ensure you understand that I might have a reason to not removing the checkmark on "Build with Runtime packages"

Yes, I understand it absolutely. And I keep the checkmark because the value it gives me is much higher than the pros of the single exe

Edit: I never use packages on the path; I always install the auto-loaded packages in the exe folder

* Clean D2007 install
* Clean computer
* New package
* without DCUs, .local, .identcache

it happens few, random times

But if I make a package with all three of mormot.core.mustache, mormot.db.sql,mormot.net.rtsphttp.pas, and any other units you want, it compiles fine

Following this rule and recreating the *.dpk and *.dproj on the first computer, it all works fine

So this "issue" is SOLVED

I do need packages, as in no-go if it doesn't work inside one
Why? My only app is an ERP, where everything is in bpl's. It's heavily customizable via packages: the customers that need customizations, have a package,a bpl, wich integrates perfectly with the program, to the point you can't tell what is "native" and what is not. Form and datamodule inheritance allows to change standard behaviours, if that is needed. And so on...

In short: yes, packages have a place in this world. Perhaps not in the microservices world, but for now that's not my world anyway