{"id":42757207,"url":"https://github.com/imixs/imixs-documents","last_synced_at":"2026-01-29T20:15:45.323Z","repository":{"id":44157006,"uuid":"172270608","full_name":"imixs/imixs-documents","owner":"imixs","description":"The open source collaboration platform for documents","archived":false,"fork":false,"pushed_at":"2025-11-05T14:06:53.000Z","size":57633,"stargazers_count":8,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-05T16:07:49.242Z","etag":null,"topics":["bpmn","business-process-management","dms"],"latest_commit_sha":null,"homepage":"https://imixs.github.io/imixs-documents/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imixs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-02-23T22:24:00.000Z","updated_at":"2025-11-05T14:07:03.000Z","dependencies_parsed_at":"2024-03-27T11:53:29.056Z","dependency_job_id":"5719ad52-7fae-4e3d-9277-3e8120ea88b3","html_url":"https://github.com/imixs/imixs-documents","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/imixs/imixs-documents","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imixs%2Fimixs-documents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imixs%2Fimixs-documents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imixs%2Fimixs-documents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imixs%2Fimixs-documents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imixs","download_url":"https://codeload.github.com/imixs/imixs-documents/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imixs%2Fimixs-documents/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28884284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T19:55:09.949Z","status":"ssl_error","status_checked_at":"2026-01-29T19:55:08.490Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bpmn","business-process-management","dms"],"created_at":"2026-01-29T20:15:42.006Z","updated_at":"2026-01-29T20:15:45.315Z","avatar_url":"https://github.com/imixs.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Imixs-Documents\n\n*Imixs-Documents* provides an **Open Source Process and Document Management Suite** for small, medium and large enterprises.\nThe Project is based on the Workflow Suite [Imixs-Office-Workflow](https://github.com/imixs/imixs-office-workflow/)\nand is licensed under the GPL.  \n\nThe goal of the project is to provide a powerful and easy-to-use *Business Process* and *Document Management* suite for companies and organizations.\nWith the help of '[Imixs-BPMN](https://www.imixs.org/sub_modeler.html)', business processes can be designed within the BPMN 2.0 standard and easily adapted to the individually needs of an enterprise.\n\n\u003ch3 align=\"center\"\u003e\u003ca href=\"https://imixs.github.io/imixs-documents/\"\u003eDocumentation \u0026amp; Quick-Installation Guide\u003c/a\u003e\u003c/h3\u003e\n\n\n## Workflow Models\n\n*Imixs-Documents* provides a selection of standard workflow models that can be used for a quick start.\nThe workflow models are provided in different languages. Switch into your preferred language for further details.\n\n - [German Workflow Models](https://github.com/imixs/imixs-documents/tree/master/workflow/de)\n - [English international workflow models](https://github.com/imixs/imixs-documents/tree/master/workflow/en)\n\nAll standard models have included a multi-level approval workflow. The approval is determined by team management at the process and space levels. \nTo add a management approval just add a manager into the corresponding process manager section.\n\nSee the [documentation](https://imixs.github.io/imixs-documents/) to learn how to interact with it!\n\n\n\n## Office Suite \n\nImixs-Documents allows to integrate an online office suite like LibreOffice Online. LibreOffice supports all major document, spreadsheet and presentation file formats, which can processed in a collaborative way within your business process. \n\n\u003cimg src=\"docs/images/wopi-01.png\" width=\"900\" /\u003e\n\n[Collabora Office](https://www.collaboraoffice.com/) with is one of the world’s most widely used Open Source office suite can be integrated easily. Found more details [here](docs/WOPI.md)\n\n\n## Optical Character Recognition (OCR)\n\nImixs-Documents includes the OCR functionality provided by the subproject [Imixs-Archive-OCR](https://github.com/imixs/imixs-archive/tree/master/imixs-archive-ocr). This feature allows you to parse the content of scanned documents for further processing. \nThe OCR solution is based on [Apache Tika](https://tika.apache.org/) and Tesseract. To activate the OCR functionality a Tika service need to be started. \n\n\t\n## Custom Forms\n\nWithin Imixs-Documents, forms can be customized from the BPMN model. This makes it easy to design business processes from scratch without coding. A so called 'Custom Form' can be defined in a BPMN Data object.\n\n\u003cimg src=\"docs/images/bpmn-02.png\" /\u003e\n\n\n The following template shows an example:\n\n\t\u003c?xml version=\"1.0\"?\u003e\n\t\u003cimixs-form\u003e\n\t  \u003cimixs-form-section columns=\"2\" label=\"Vertragsdaten\"\u003e\n\t    \u003citem name=\"contract.name\" type=\"text\"  label=\"Partner:\" /\u003e\n\t    \u003citem name=\"contract.number\" type=\"text\"  label=\"Nummer:\" /\u003e\n\t    \u003citem name=\"contract.start\" type=\"date\"  label=\"Beginn:\" /\u003e\n\t    \u003citem name=\"contract.end\" type=\"date\"  label=\"Ende:\" /\u003e\n\t    \u003citem name=\"contract.fee\" type=\"float\"  label=\"Gebühr:\" /\u003e\n\t  \u003c/imixs-form-section\u003e\t\n  \t  \u003cimixs-form-section columns=\"2\" label=\"Zahlungsdaten\"\u003e\n\t    \u003citem name=\"payment.cycle\" type=\"text\"  label=\"Abrechnungsperiode:\" /\u003e\n\t    \u003citem name=\"payment.type\" type=\"text\"  label=\"Zahlungsart:\" /\u003e\n\t    \u003citem name=\"cdtr.iban\" type=\"text\"  label=\"IBAN:\" /\u003e\n\t    \u003citem name=\"cdtr.bic\" type=\"text\"  label=\"BIC:\" /\u003e\n\t    \u003citem name=\"cdtr.name\" type=\"text\"  label=\"Kreditor:\" /\u003e\n\t  \u003c/imixs-form-section\u003e\t \n\t\u003c/imixs-form\u003e\n\n\nFind details how to model custom forms [here](./docs/modeling/CUSTOM_FORMS.md).\n\n### Predefined Items\n\nThe following sections list the business items predefined by Imixs-Documents.\nFor application specific item names the ‘dot.Case’ format is recommended. It’s basically a convention that makes it easier to see what properties are related.\n\n\n \n| Item            | Type   \t| Description\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|-----------------|---------|---------------------------------------------------------------|\n|**Request**      |      \t|                                                               |\n|request.subject  | text \t| Subject\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|request.name     | text \t| Requester name\t\t\t\t\t\t\t\t\t\t\t\t|\n|request.email    | text\t| Requester E-Mail\t\t\t\t\t\t\t\t\t\t\t\t|\n|request.number   | text\t| Order number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|**Order** \t      |      \t|                                                               |\n|order.name       | text \t| Order name\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|order.number     | text\t| Order number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|order.delivery   | date\t| Delivery date\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|order.total   \t  | float\t| Order total amount\t\t\t\t\t\t\t\t\t\t\t|\n|**Invoice**      |     \t|                                                               |\n|invoice.number   | text   \t| Invoice number\t\t\t\t\t\t\t\t\t\t\t\t|\n|invoice.date     | date  \t| Invoice Date\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|invoice.total    | float  \t| Invoice total amount\t\t\t\t\t\t\t\t\t\t\t|\n|invoice.vat      | float  \t| Invoice vat \t\t\t\t\t\t\t\t\t\t\t\t\t|\n|invoice.net      | float  \t| Invoice net amount \t\t\t\t\t\t\t\t\t\t\t|\n|invoice.currency | text  \t| currency code\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|**Contract** \t  |      \t|                                                               |\n|contract.name    | text \t| Contract name\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|contract.partner | text \t| Contract partner name\t\t\t\t\t\t\t\t\t\t\t|\n|contract.number  | text\t| Contract number\t\t\t\t\t\t\t\t\t\t\t\t|\n|contract.start   | date\t| Contract start date\t\t\t\t\t\t\t\t\t\t\t|\n|contract.end     | date \t| Contract end date\t\t\t\t\t\t\t\t\t\t\t\t|\n|contract.fee     | float \t| Contract fee per billing cycle\t\t\t\t\t\t\t\t|\n|**Creditor**     |        \t|                                                               |\n|cdtr.name        | text  \t| Creditor name\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|cdtr.iban        | text  \t| IBAN number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|cdtr.bic         | text  \t| BIC number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|**Debitor**  \t  |        \t|                                                               |\n|dbtr.name        | text  \t| Debitor name\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|dbtr.iban        | text  \t| IBAN number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|dbtr.bic         | text  \t| BIC number\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|**Payment**      |        \t|                                                               |\n|payment.type \t  | text   \t| credit card, SEPA\t\t\t\t\t\t\t\t\t\t\t\t|\n|payment.date \t  | date   \t| payment date\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|payment.total \t  | float   | payment amount\t\t\t\t\t\t\t\t\t\t\t\t|\n|payment.cycle \t  | text  \t| payment cycle (monthly, yearly, fixed date\t\t\t\t\t|\n\n\n\n\n\n\n\n\n## Imixs-ML\n\nImixs-Documents supports the integration of the [Imixs-ML framework](https://github.com/imixs/imixs-ml). To activate the Imixs-ML functionality a Imixs-ML-Spacy service and an optional Imixs-ML-Training Service need to be started. \nThe docker-compose yaml file docker/docker-compose-ml.yml shows an example setup of the service integration.\n\nOptional custom ML models can be integrated by adding a docker volume. E.g:\n\n\t./src/models/:/usr/src/app/models/\n\t\n\t\n\n\n\n## Contribute\nThe source code of Imixs-Documents is free available on [Github](https://github.com/imixs/imixs-documents). \nIf you have any questions about how Imixs-Documents works and how you can use it in your own project, you can ask your question on the [GitHub Issue Tracker](https://github.com/imixs/imixs-documents/issues). \nWith a pull request on GitHub you can share your ideas or improvements that you want to contribute.\n\n \n\n## Need Help?\n\n[Imixs Software Solutions GmbH](http://www.imixs.com) is an open source company and we are specialized in business process management solutions (BPMS). If you need professional services or consulting for your own individual software project [please contact us](mailto:info@imixs.com). \n\n \n\n\n\u003cbr /\u003e\u003cbr /\u003e\u003cimg src=\"small_h-trans.png\" /\u003e\n\n\n**Imixs-Office-Workflow** provides a Docker Image to run the service on any Docker host. \nThe docker image is based on the docker image [imixs/wildfly](https://hub.docker.com/r/imixs/wildfly/) which can be used for development as also for production.\n\n\n\n\n## Maven Build\n*Imixs-Documents* is based on [Maven](http://maven.apache.org/) and runs on the Jakarta EE stack. Imixs-Office-Workflow can be deployed on JBoss/Wildfly server or other Java EE application servers.\nTo build the application from sources, run the maven install command first:\n\n\t$ mvn clean install\n\nPlease check the pom.xml file for dependencies and versions. The master-branch of the project is continuously under development and is typically \nagainst the latest snapshot releases form the Imixs-Workflow project. To run a stable version please build a [tagged version](https://github.com/imixs/imixs-office-workflow/releases). \nTo deploy the artifact the application server must provide a database pool named \"java:/jdbc/office\" and a security domain/realm named 'office'. See also the [Imixs-Workflow Deployment Guide](http://www.imixs.org/doc/deployment/index.html) for further details.\n\n\n\n\n## Docker for Development\nDevelopers can use a docker image for testing and the development of new features. To build a new container first build the maven artefact running: \n\n\t$ mvn clean install -Pdocker\n\nTo start Imixs-Office-Workflow with docker, the docker-compose command line tool an be used:\n\n\t$ docker-compose -f docker/docker-compose.yml up\n\nNote: this command will start several containers, \n\n* a Postgre SQL database server \n* a Wildfly Server running Imixs-Documents\n\nOptional you can run the docker-compose configuration docker/docker-compose-dev.yml which will also start a the [Imixs-Admin tool](https://www.imixs.org/doc/administration.html) \n\n\t$ docker-compose -f docker/docker-compose-dev.yml up\n\n### Mount Points\nThe development configuration sets a local mount point at the following location:\n\n\t~/git/imixs-office-workflow/src/docker/deployments\n\nMake sure that this directory exits. During development new versions can easily deployed into this directory which is the auto-deployment folder of Wildfly. For further details see the [imixs/wildfly docker image](https://hub.docker.com/r/imixs/wildfly/).\n\n\n\n\n## Docker for Production\n\nTo run Imixs-Documents in a Docker production environment the project provides several additional maven profiles:\n\n\n### docker-build\n\nWith the profile '_docker-build_' a docker container based on the current version of Imixs-Office-Workflow is created locally\n \n\t$ mvn clean install -Pdocker\n\n\n### docker-push\n\nWith the '_docker-push_' profile the current version of Imixs-Office-Workflow can be pushed to a remote repository:\n\n\t$ mvn clean install -Pdocker-push -Dorg.imixs.docker.registry=localhost:5000\n\nwhere 'localhost:5000' need to be replaced with the host of a private registry. See the [docker-push command](https://docs.docker.com/docker-cloud/builds/push-images/) for more details.\n\n### docker-hub\n\nImixs-Office-Workflow is also available on [Docker-Hub](https://hub.docker.com/r/imixs/imixs-office-workflow/). The public docker images can be used for development and production. If you need technical support please contact [imixs.com](http://www.imixs.com) \n\n\n\n## Kubernetes\n\n\n*Imixs-Documents* provides a base deployment configuration for Kubernetes. The setup is based on [Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) providing a declarative object management.\n\n\nTo create the deployment objects from the base-deployment run:\n\n\t$ kubectl apply --kustomize https://github.com/imixs/imixs-documents/kubernetes/\n\nThe service endpoint of Imixs-Documents will be published on port 8080.\nThis basic deployment configuration assumes that  a default storage class is defined within your kubernetes cluster. This storage class will be used for the database storage and the search index. You can customize the service and persistence volume configuration to your needs by using a [custom setup](./kubernetes/README.md).  \n\t\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimixs%2Fimixs-documents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimixs%2Fimixs-documents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimixs%2Fimixs-documents/lists"}