Documentation

Project server

Shared projects for a team: several users work on the same project, each page is locked by one of them.

openecraft-project-server stores projects for a team. Several users open the same project at the same time and work on different pages; a page is edited by one user at a time.

cargo run --release -p openecraft-project-server -- --bind 0.0.0.0:8091 --data projects --token <secret>
cargo run --release -p openecraft-project-server -- --config project-server.toml

As a container: docker run -d -p 127.0.0.1:8091:8091 -e OPENECRAFT_PROJECT_TOKEN=<secret> -v projects:/data ghcr.io/nilres/openecraft-project-server (see installation).

Public project server

The project runs a public project server at project-server.openecraft.org with its web page switched on. Working on it needs an account: sign in on the web page to see the projects you may open, and enter the server URL https://project-server.openecraft.org in the editor's Project server pane and sign in there with the same account. It shows how several users work on one project; projects of a company belong on a project server of its own (above), behind its own access settings.

Below the web page (--web) are the links Privacy and, when the operator has a name, Legal notice (in German Datenschutz and Impressum), each opening a dialog, and the disclaimers of OpenECraft (no warranty, the product names it mentions belong to their owners). They are there without sign-in, as for the website, whose fields and variables are the same:

Key of [legal]VariableShows
nameOPENECRAFT_LEGAL_NAMEThe person or company running the server; empty hides the legal notice
addressOPENECRAFT_LEGAL_ADDRESSIts postal address
emailOPENECRAFT_LEGAL_EMAILEmail address, as a link
phoneOPENECRAFT_LEGAL_PHONEPhone number
representativeOPENECRAFT_LEGAL_REPRESENTATIVEWho represents a company
registerOPENECRAFT_LEGAL_REGISTERRegister court and number
vatOPENECRAFT_LEGAL_VAT_IDVAT identification number
responsibleOPENECRAFT_LEGAL_RESPONSIBLEWho is responsible for the content, with address
textOPENECRAFT_LEGAL_TEXTFurther text: disclaimers, dispute resolution
privacyOPENECRAFT_LEGAL_PRIVACYWhat the operator adds to the privacy notice: the hosting, the logs, whom to ask

Set them in the table [legal] of the configuration file or with the variables, which win; lines of the address and of the texts are separated by | (or line breaks in the file). GET /api/v1/legal answers them as JSON. The labels follow the language of the page; the values are shown as they are set.

The privacy notice says what the page and the server do, in the language of the page: no cookies, no tracking, nothing loaded from other servers; the language, the settings of the page and the key of the session in the storage of the browser; the accounts (name, role, groups, the password as a hash); the failed sign-ins remembered for a short time; who works on which project and when (sessions, locks, the latest ended sessions) and who changed a project last. What only the operator knows (who hosts the server, what a reverse proxy logs and for how long, whom to ask, as Article 13 GDPR asks for) is set in privacy and shown below it. Keep the texts true: a change that stores or sends something else changes them too (renderLegal of common.js, privacy() of the page's script). Whether a server needs a legal notice, and what it has to say, depends on the operator and the country: OpenECraft only shows what is set.

This document in the repository

More documentation

Getting started: from the first page to the bill of materials

This tutorial walks through a small control circuit in OpenECraft: pages, symbols, wires, devices with parts, terminals, a PLC, the project check, reports, the panel layout and the output. Commands are written as Tab ›…

Read

Installation and building

Packages for Windows, Linux and macOS, the web version, and building from source.

Read

User interface

The editor's layout and the commands and keys of everyday work. New users start with the tutorial.

Read

Schematic editor

Pages, devices and their structure, live cross references, editing tools, navigators and project storage. The user interface lists the commands and keys.

Read

Symbols and libraries

The built-in symbol libraries (IEC, NFPA / JIC, GB, GOST, JIS, fluid power, P&ID, single-line) and the symbol editor for own symbols.

Read

Wires, cables, potentials and numbering

How connections get their cable, colour, cross-section and number, and how devices, pages and wires are numbered.

Read

Terminal strips, plugs, PLC and marking

Terminal strips with multi-level terminals and accessories, plugs, PLC cards with the exchange to PLC programming tools, and the markers for the workshop.

Read

Macros, configurator and table editing

Reuse of circuits as macros with variants and placeholders, pages generated by the configurator, and bulk changes in tables and spreadsheets.

Read

Parts management

The parts database shared by all projects (EPLAN style): commercial, technical and mounting data, function templates, connection points, 2D / 3D graphics and the import of manufacturer data. Parts are shared between…

Read

Reports, forms and the project check

Reports as windows, CSV / Excel or live report pages, title blocks and report forms (also graphical and own drawn forms), and the project check with its message management.

Read

Electrical sizing, calculations and verification

Conductor sizing, short circuit and protection coordination, load calculation, EMC, functional safety and rule sets – all part of the project check – and the inspection and test report of the installation.

Read

Panel layout, rooms and 3D routing

OpenECraft aligns the device's clip to the rail centerline. For Beckhoff's 12 × 100 × 68 mm EL I/O housings with 8 or 16 terminals, and the matching EK1100 coupler, the rail center is 63.8 mm from the top. For example…

Read

Wiring and mounting assistants

The panel layout as a checklist for the workshop, on a desktop or a tablet.

Read

Fluid power, process and plant engineering

Hoses and pipes in their own nets, electro-fluid links, PCT loops, the pre-planning of the plant and single-line / multi-line engineering.

Read

Wire harnesses

Harnesses with 3D topology, protections and fixings, KBL export, the harness interface for machines and nailboard drawings (Connections › Harnesses…). The example project conveyor has a door harness.

Read

Output and data exchange

PDF, DXF / DWG, SVG and 3D exports, DXF / DWG import, the enterprise integration layer (ERP, PDM, PLM, ECAD, MCAD, procurement, wiring machines) and Autodesk Vault.

Read

Revisions, review and change management

Revisions with locked pages and marked changes, the approval workflow, baselines with compare and merge, comments and redlining, and change requests.

Read

Command line, MCP server and plugins

Projects and the parts server without a window, for scripts and AI agents.

Read

Plugins

OpenECraft is extended through the openecraft-api crate. A plugin adds

Read

Parts server and parts manager

The data portal shared by all OpenECraft installations and the app that maintains it.

Read

Access control of the servers

The parts server and the project server share one access model: users sign in with a local account or with a directory (Active Directory, OpenLDAP or another LDAP server), and what they may do comes from roles given to…

Read