|
1 | | -# Installation |
| 1 | +# Installation Guide |
2 | 2 |
|
3 | | -Imixs-BPMN is based on < a href= "https://github.com/imixs/open-bpmn/" target= "_blank" >Open-BPMN</ a> - a free BPMN 2.0 modelling platform. It can be used in < strong>Visual Studio Code</ strong>, as a < strong>Eclipse Plugin</ strong> or in a Web Browser. Further more, Open BPMN provides an extension mechanism to adapt the modeling platform to the individual requirements in any business process project. Read more about <a href=" https://github.com/imixs/open-bpmn/" |
4 | | -target="_blank">Open BPMN</a>. |
| 3 | +The architecture of **Open BPMN** makes it possible to run the modeller on various IDEs and platforms. It can be installed on different IDEs such as [Visual Studio Code](https://code.visualstudio.com/) or [Eclipse Theia](https://theia-ide.org/) or it can be run as a standalone web application. |
5 | 4 |
|
6 | | -## Visual Studio Code |
| 5 | +## Install Eclipse Theia (💥 Recommended) |
7 | 6 |
|
8 | | -To install Imixs-BPMN in Visual Studio Code (VSCode), go to the 'Extensions Settings' and search for 'Open-BPMN' to install. |
| 7 | +[Eclipse Theia](https://theia-ide.org) is the recommended platform for **Open-BPMN**. It provides a highly flexible and modern IDE experience, featuring a powerful AI integration that significantly enhances the modeling and development workflow. |
9 | 8 |
|
10 | | -<img src="../images/modelling/install-vscode-01.png"/> |
| 9 | +To install the **Theia IDE**, follow these steps: |
11 | 10 |
|
12 | | -After installing the extension you can create and edit .bpmn and .bpmn2 files within your IDE. |
13 | | -## Eclipse IDE |
| 11 | +1. Download the latest installer for your operating system from the [official Eclipse Theia website](https://theia-ide.org/). |
| 12 | +2. Run the installer and follow the on-screen instructions. |
| 13 | +3. Theia is cross-platform and runs on Windows, macOS, and Linux, providing a seamless experience across all environments. |
| 14 | +4. Once installed, launch the application to start your workspace. |
14 | 15 |
|
15 | | -For installation of the Imixs-BPMN Modeler in Eclipse. If you do not have an Eclipse installation yet, you can download Eclipse from the [Eclipse website](http://www.eclipse.org/). |
| 16 | +**Installing the Open-BPMN Extension:** To run [Open BPMN Extension](https://open-vsx.org/extension/open-bpmn/open-bpmn-vscode-extension) in the Theia IDE, simply open the Extensions view from the sidebar (or press `Ctrl+Shift+X`). Search for **"Open-BPMN"** in the Open VSX Registry and click **Install**. After the installation, you can immediately start modeling by opening any .bpmn file. |
16 | 17 |
|
17 | | -You can install Imixs-BPMN directly from the Eclipse Marketplace by dragging the install button to your running Eclipse workspace: |
| 18 | +<img src="../bpmn/theia-integration-install.png" width="500" /> |
18 | 19 |
|
19 | | -<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=2309267" class="drag" title="Drag to your running Eclipse workspace to install Imixs-BPMN"><img class="img-responsive" src="https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png" alt="Drag to your running Eclipse workspace to install Imixs-BPMN" /></a> |
20 | | - |
21 | | -### Installation from the Updatesite |
22 | | -Imixs-BPMN is installed the same way as any other Eclipse plugin.To install the Imixs-BPMN plugin select from the Eclipse Workbench main menu: *Help -> Install New Software*. |
23 | | - |
24 | | -Enter the following update site URL: |
25 | | - |
26 | | - * https://www.imixs.org/org.imixs.eclipse.bpmn2.updatesite/ |
27 | | - |
28 | | -<img src="../images/modelling/bpmn_screen_02.png"/> |
| 20 | +## Install in Visual Studio Code |
29 | 21 |
|
| 22 | +[Visual Studio Code](https://code.visualstudio.com/) (VS-Code) is a popular, lightweight editor that fully supports the Open-BPMN modeling suite through its extension mechanism. |
30 | 23 |
|
31 | | -Finally you have to restart your Eclipse IDE. |
32 | | - |
33 | | -You will find additional information about the Eclipse BPMN2 Modeler |
34 | | -plugin at: https://www.eclipse.org/bpmn2-modeler/ |
| 24 | +To install **Visual Studio Code**, follow these steps: |
35 | 25 |
|
36 | | - |
37 | | - |
| 26 | +1. Visit the VS-Code Download page and select the version for your OS (Windows, macOS, or Linux). |
| 27 | +2. Download and run the setup file to install the application on your local machine. |
| 28 | +3. Follow the installation wizard, which allows you to add VS-Code to your PATH for easy command-line access. |
| 29 | +4. Launch VS-Code and you are ready to customize your environment. |
| 30 | + |
| 31 | +**Installing the Open-BPMN Extension:** To add the [Open BPMN Extension](https://marketplace.visualstudio.com/items?itemName=open-bpmn.open-bpmn-vscode-extension), navigate to the **Extensions** view in the activity bar on the side of VS-Code. Search for "Open-BPMN" and click the Install button. |
| 32 | + |
| 33 | +<img src="../bpmn/vscode-integration-install.png" width="500" /> |
| 34 | + |
| 35 | +## JDK 17 Support |
| 36 | + |
| 37 | +Note: The Open-BPMN extension is based on JDK 17. Please ensure you have [Java 17 or higher installed on your system](https://adoptium.net/). |
| 38 | + |
| 39 | +## Run With Docker |
| 40 | + |
| 41 | +Open-BPMN can also be run as a Web Application in a Docker Container. This solution includes the Eclipse Theia Platform. To run Open-BPMN with docker just start a local Docker container: |
| 42 | + |
| 43 | + $ docker run -it --rm --name="open-bpmn" \ |
| 44 | + -p 3000:3000 \ |
| 45 | + imixs/open-bpmn |
| 46 | + |
| 47 | +After starting the container the application is accessible from your Web Browser: |
| 48 | + |
| 49 | + http://localhost:3000 |
| 50 | + |
| 51 | +<img src="../bpmn/imixs-bpmn-001.png" width="500" /> |
| 52 | + |
| 53 | +### Workspace Directory |
| 54 | + |
| 55 | +The Theia Client is using a local workspace directory `/usr/src/app/open-bpmn.glsp-client/workspace`. The workspace directory is the place to create and edit the BPMN files. With Docker you can change the workspace directory and map it to a local directory with the Docker param -v |
| 56 | + |
| 57 | +In the following example the workspace is mapped to the local directory `/tmp/my-workspace` |
| 58 | + |
| 59 | + $ docker run -it --rm --name="open-bpmn" \ |
| 60 | + -p 3000:3000 \ |
| 61 | + -v /tmp/my-workspace:/usr/src/app/open-bpmn.glsp-client/workspace \ |
| 62 | + imixs/open-bpmn |
| 63 | + |
| 64 | +## Kubernetes |
| 65 | + |
| 66 | +You can also run Open-BPMN in a Kubernetes cluster. The following is a deplyoment yaml file that you can use as a template for your own configuration. Note also in Kubernetes you can map the workspace directory to a persistence volume. |
| 67 | + |
| 68 | +``` |
| 69 | +--- |
| 70 | +################################################### |
| 71 | +# Deployment office-demo |
| 72 | +################################################### |
| 73 | +apiVersion: apps/v1 |
| 74 | +kind: Deployment |
| 75 | +metadata: |
| 76 | + name: modeler-app |
| 77 | + namespace: open-bpmn |
| 78 | + labels: |
| 79 | + app: modeler-app |
| 80 | +spec: |
| 81 | + replicas: 1 |
| 82 | + selector: |
| 83 | + matchLabels: |
| 84 | + app: modeler-app |
| 85 | + strategy: |
| 86 | + type: Recreate |
| 87 | + template: |
| 88 | + metadata: |
| 89 | + labels: |
| 90 | + app: modeler-app |
| 91 | + spec: |
| 92 | + containers: |
| 93 | + - image: imixs/open-bpmn:latest |
| 94 | + name: modeler-app |
| 95 | + imagePullPolicy: Always |
| 96 | + env: |
| 97 | + - name: TZ |
| 98 | + value: Europe/Berlin |
| 99 | + ports: |
| 100 | + - name: web |
| 101 | + containerPort: 3000 |
| 102 | + resources: |
| 103 | + requests: |
| 104 | + memory: "128M" |
| 105 | + limits: |
| 106 | + memory: "1G" |
| 107 | + restartPolicy: Always |
| 108 | +
|
| 109 | +
|
| 110 | +--- |
| 111 | +################################################### |
| 112 | +# Service open-bpmn |
| 113 | +################################################### |
| 114 | +apiVersion: v1 |
| 115 | +kind: Service |
| 116 | +metadata: |
| 117 | + name: modeler-app |
| 118 | + namespace: open-bpmn |
| 119 | +spec: |
| 120 | + ports: |
| 121 | + - protocol: TCP |
| 122 | + name: web |
| 123 | + port: 3000 |
| 124 | + selector: |
| 125 | + app: modeler-app |
| 126 | +``` |
| 127 | + |
| 128 | +To deploy Open-BPMN in your cluster create the namespace and apply your Pod configuration: |
| 129 | + |
| 130 | + $ kubectl create namespace open-bpmn |
| 131 | + $ kubectl apply -f apps/open-bpmn |
0 commit comments