Metadata Editor

Appearance

Installation overview ​

The Metadata Editor is deployed as a web application on a server (or as a desktop bundle for training). Most production setups run three cooperating components on the same host:

ComponentRoleRequired?
Metadata EditorWeb UI, API, MySQL metadata, job queueYes
FastAPI serviceMicrodata conversion, statistics, indicator timeseries dataYes, when importing or processing data
Background workerJob queue processing (batch, API automation)Optional — see Jobs and background workers

The FastAPI service is the Metadata Editor FastAPI application — a local companion for file conversion and indicator storage, not a public API.

Installing on a server supports collaboration, centralized storage, and integration with your organization’s authentication. For a personal training setup, see Installation (Desktop).

Choose your installation path ​

EnvironmentGuide
Linux server (Apache or NGINX)Installation (Linux)
Windows server (IIS)Installation (Windows)
Desktop (Windows 10/11, training)Installation (Desktop)
Upgrade an existing installUpgrading

After platform-specific steps, complete Post-install configuration (FastAPI service connection, storage paths, email, verification).

Standard folder layout ​

Use a single parent directory on the server. Names below are conventions used in this guide; your paths may differ as long as configuration files point to the correct locations.

metadata-editor/
├── editor/          ← Metadata Editor (PHP application root; contains index.php)
└── fastapi/         ← FastAPI service (Metadata Editor FastAPI application root)

Examples:

  • Linux: /var/www/metadata-editor/editor and .../fastapi
  • Windows (IIS): C:\inetpub\metadata-editor\editor and ...\fastapi

Clone or extract releases from:

Prefer tagged releases over the default branch for production.

System requirements ​

ComponentRequirement
CPUDual-core or higher
RAM4 GB minimum; 8 GB+ recommended for large datasets
Storage20 GB+ free; project data grows under the editor datafiles area
DatabaseMySQL 8.x or MariaDB 10.x+
PHP8.2+ with extensions: mysqli, xsl, xml, mbstring, curl, openssl, zip
Python3.11+ for the FastAPI service (Conda or .venv; see Install and configure the FastAPI service)
Web serverApache 2.4+, NGINX, or IIS 10+

PHP installation details: PHP installation. Architecture summary: Technical specifications.

Installation checklist (all server paths) ​

  1. Install web server, PHP, MySQL, and Python (platform guide).
  2. Create metadata-editor/editor and metadata-editor/fastapi; download source.
  3. Create MySQL database and user; configure editor/application/config/database.php.
  4. Set permissions on datafiles, files, and logs under the editor root.
  5. Run the web installer in a browser (creates schema and admin account).
  6. Install and configure the FastAPI service (.env, STORAGE_PATH, test).
  7. Post-install configuration — link editor to FastAPI service, email, smoke tests.
  8. (Optional) Background worker for batch and API jobs.
  9. (Production) Run the FastAPI service and enable backups.