Architecture overview
Publication: OpenForex Society / OpenForex Foundation. Updated 2026-09-24.
Two documentation runtimes
The project contains a working PHP reader and configuration for an optional Wiki.js environment. They are separate runtimes. Starting the PHP site does not start Wiki.js, PostgreSQL, Redis, or a financial API.
| Runtime | Entry point | Content source | Editing model |
|---|---|---|---|
| Root PHP portal | localhost/openforex.io/ | Markdown directories in this workspace | Edit files and deploy a reviewed revision |
| Shared-hosting PHP portal | public_html/index.php | Sibling content directories | Same reader, package-relative assets |
| Optional Wiki.js stack | localhost:8080 by default | Wiki.js and PostgreSQL | Application permissions and optional import script |
PHP request flow
The entry point sets the content root and asset prefix, then loads the shared reader. The reader builds an allowlisted catalog from known Markdown directories. A page query selects a catalog entry; unknown identifiers return 404. Markdown is escaped and rendered using the bundled subset renderer. Search data is included in the response and filtered in the browser.
This is a read-only public portal, not an authenticated authoring application. Every document in an indexed directory is intended for public reading. Keep unpublished, confidential, or credential-bearing files outside those directories.
Optional container stack
The supplied Compose file declares Nginx, Wiki.js, PostgreSQL, and Redis on the ofw-net network. Nginx proxies to Wiki.js on port 3000. PostgreSQL, Redis, and Wiki.js have named persistent volumes.
Redis is configured as a service and environment variables are passed to Wiki.js. That configuration alone does not demonstrate active cache or session integration; verify behavior in a running environment before relying on it.
Source and publication boundaries
The Markdown files are the reviewable baseline. If Wiki.js is used for editing, define which copy is authoritative and how changes return to the source tree. Do not overwrite authored content with a seed import without reviewing differences and retaining a backup.
Deployment responsibilities
Choose one public document root, protect configuration and backups, set the official repository URL, and verify routes and downloads. For production hosting, use a supported runtime and a tested server configuration appropriate to that host; this source inventory is not a validation of a deployed environment.
See portal operations, shared hosting, and API reference.
Sources & citation
- Material type
- Project reference
- Publisher
- OpenForex Society
OpenForex Society. “Architecture overview.” https://openforex.io/?page=docs%2Farchitecture. Include your access date when citing.
Download the exact published MarkdownText fingerprint (SHA-256)
edf2617a450122c9ea4145e4762bd8648174d1761cdf8637d4d7e080e8ef90f4This identifies the downloadable text, not an independent approval or a permanent archived edition.
Referenced material (3)
- portal operationsProject reference
- shared hostingProject reference
- API referenceProject reference
Standards, implementation references and worked calculations identify their sources and publication status. Read our sourcing and corrections policy.