Änderungen von Dokument Plugin-Entwicklung

Von 12.1 nach 11.1 Von 15.2 nach 15.1

Von Version 15.1

bearbeitet von awa
am 04.12.2022, 00:49

Änderungskommentar: Neuen Anhang README-FC-SERVER.md hochladen

Auf Version 12.1

bearbeitet von awa
am 04.12.2022, 00:43

Änderungskommentar: Uploaded new attachment "README.md", version 1.1

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 1 hinzugefügt, 1 gelöscht)
- README-FC-SERVER.md
- README.md

Details

Seiteneigenschaften

Inhalt

@@ -314,5 +314,3 @@
  Dies funktioniert auch in einem Ordner ohne Maven-Projekt. Falls keine {{formcycle/}}-Version angegeben ist, wird eine Standard-Version genommen, abhängig von der Maven-Plugin-Version.
--Für fortgeschrittenen Gebrauch siehe die [[README.md>>attach:README-FC-SERVER.md||rel="__blank"]].
--

README-FC-SERVER.md

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.awa

Größe

...	...	@@ -1,1 +1,0 @@
1		-15.1 KB

Inhalt

@@ -1,495 +1,0 @@
--Maven plugin for starting a FORMCYCLE server, similar to the Jetty maven plugin, but initializes the FORMCYCLE application.
--
--## TL;DR
--
--Version 8:
--
--```bash
--# Standalone
--mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0:ms -DxfcVersion=8.0.4
--
--# FORMCYCLE plugin project
--mvn fc-server:run-ms-war
--```
--
--Version 7:
--
--> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
--
--## Versioning
--
--* The major and minor version are always equal to the FORMCYCLE major version against which the project was built.
--* The patch version is for the plugin.
--
--## Terms
--
--A "FORMCYCLE plugin project" is Maven project packaged as a fat jar, with a (possibly transitive)
--compile dependency on `de.xima.fc:fc-plugin-common` in the `provided` scope.
--
--A Maven project "packaged as a fat jar" is Maven project with its `packaging` set to `jar` and
--that includes a plugin execution for either the `maven-assembly-plugin` or the `maven-shade-plugin`.
--
--## Goals
--
--See the site above for more in-depth info.
--
--* `ms` Intended for use as a command line tool to start a server without a Maven project:
--  `mvn fc-server:ms`.
--* `run-ms-war` Intended for use as a command line tool to start a server on an existing
--  [FORMCYCLE plugin project](#terms): `mvn fc-server:ms`.
--* `start-ms-war` Goal for integration into an existing lifecycle defined in a pom.xml, should be
--  bound to a particular phase. Does not block by default.
--
--## Usage
--
--This is a Maven plugin with several goals. You can run it via the command line:
--
--```bash
--# When you have no Maven project
--mvn fc-server:ms
--
--# When you have an existing FORMYCLE plugin project
--mvn fc-server:run-ms-war
--```
--
--If the command is run from within an existing Maven project, it first packages the project, then starts the server and finally (if `-DdeployMavenProject=true` is set), installs the main artifact file of the Mavne project automatically into the started FORMCYCLE instance.
--
--The first command can be used in a directory without a Maven project.
--
--If the second command is run on an existing [FORMCYCLE plugin project](#terms), it first packages that project, then
--starts the server and finally installs the main artifact file of the Maven project automatically into the started
--FORMCYCLE instance.
--
--If Maven cannot find the plugin or you need to run a specific version of the plugin, you have to use the full coordinates:
--
--> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0-SNAPSHOT:run-ms-war
--
--To get Maven to find the plugin without the full name, either add the plugin to `<plugin>` section of your `pom.xml` or add the following to the `~/.m2/settings.xml`:
--
--```xml
--<settings>
--  <pluginGroups>
--    <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
--  </pluginGroups>
--</settings>
--```
--
--If you want to configure the plugin, you can do so via a `<plugin>` section in the `pom.xml`. See the
--site above for documentation.  Below are some example configurations.
--
--### Use a different FORMCYCLE version
--
--The FORMCYCLE version defaults to the version against which the version of the plugin was built. The plugin major and minor version always follow the FORMCYCLE version, e.g. plugin version 7.0.9 will default to some `7.0.x` release of FORMCYCLE.
--
--To set the version of the FORMCYCLE app:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <xfcVersion>7.0.7</xfcVersion>
--  </configuration>
--</plugin>
--```
--
--Note that you can also use:
--
--> mvn fc-server:ms -DxfcVersion=7.0.7
--
--You may have to use a different version of the plugin for older FC versions (major and minor plugin version always follow the FC version)
--
--> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
--
--### Use a custom FORMCYCLE war file
--
--If you need to, you can also use a custom FORMCYCLE WAR file, e.g. a local build etc.
--
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <warFile>/path/to/formcycle.war</warFile>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -DwarFile=/path/to/formcycle.war
--
--### Change servlet container settings
--
--You can change the server context path and port:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <contextPath>form-server</contextPath>
--    <port>8099</port>
--  </configuration>
--</plugin>
--```
--
--You can also use specify these settings on the command line:
--
--> mvn fc-server:ms -DcontextPath=form-server -Dport=8090
--
--### Change app persistence directory
--
--All FORMCYCLE specific data such as the log files, configuration files or temporary files are stored in the application directory in the `target` folder. You can use a different app directory if you want.
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <appDir>${project.basedir}/xfc-server</appDir>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -DappDir=target/apps/xfc-server
--
--### Use a different servlet container
--
--By default, Jetty is used, but this can be changed:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <container>tomcat:9</container>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -Dcontainer=tomcat:9
--
--By default, supported values are currently
--
--* `jetty:10` - Jetty Servlet Container Version 10.x
--* `tomcat:9` - Apache Tomcat Version 9.x
--
--To use a custom container, include a `de.xima.servletcontainer.api.IServletContainerProvider` in
--the classpath and specify the corresponding name.
--
--### Use in-memory H2 database
--
--By default, the H2 database is stored in a file, so the data is persisted when you restart the server. But you can also use an in-memory database:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <h2Storage>ram</h2Storage>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -Dh2Storage=ram
--
--### Use a different database
--
--Include the driver via `dbDrivers` and configure the `database.properties`:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <dbDrivers>
--      <dbDriver>postgresql</dbDriver>
--	</dbDrivers>
--    <databaseProperties>
--      <properties>
--        <property>
--          <name>db.connection.dbms.shortname</name>
--          <value>postgresql</value>
--        </property>
--        <property>
--          <name>db.connection.jdbcurl</name>
--          <value>jdbc:postgresql://localhost:5432/my_database</value>
--        </property>
--        <property>
--          <name>db.connection.login.username</name>
--          <value>USERNAME</value>
--        </property>
--        <property>
--          <name>db.connection.login.password</name>
--          <value>PASSWORD</value>
--        </property>
--      </properties>
--    </databaseProperties>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line (separate multiple drivers with a comma):
--
--> mvn fc-server:ms -DaddDbDrivers=postgresql,h2 -DdbShortname=postgresql -DdbJdbcUrl=jdbc:postgresql://localhost:5432/my_database -DdbUsername=USERNAME -DdbPassword=PASSWORD
--
--Supported database drivers are
--
--* `h2`
--* `mariadb`
--* `mysql`
--* `oracle`
--* `postgresql`
--* `sqlserver`
--* `custom` (does not add any driver, add your own driver via `dependencies`)
--
--### Create default clients
--
--You can add additional clients to be created when the FORMCYCLE app starts. When the client exists already, it is updated with the configured settings. Clients are identified by their `name`.
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <bootstrap>
--      <clientManagement>
--        <!-- Do not create the default client -->
--				<excludeDefaults>true</excludeDefaults>
--        <clients>
--          <!-- Create a default client -->
--          <client>
--            <baseSettings>
--              <name>myforms</name>
--              <alias>Formular</alias>
--              <languageTag>de</languageTag>
--              <baseUrl>http://10.42.42.50/form-server</baseUrl>
--              <description>Client for testing forms</description>
--            </baseSettings>
--            <adminUser>
--              <userName>awa</userName>
--              <email>awa@xima.de</email>
--              <givenName>Andre</givenName>
--              <lastName>Wachsmuth</lastName>
--              <password>12345678</password>
--            </adminUser>
--          </client>
--        </clients>
--      </clientManagement>
--    </bootstrap>
--  </configuration>
--</plugin>
--```
--
--### Including additional plugins
--
--You can include additional plugins that should be installed after the FORMYCLE app was started:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <bootstrap>
--      <pluginManagement>
--        <plugins>
--          <!-- You can specify a Maven coordinate when the plugin is available via Maven -->
--          <plugin>
--            <location>de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22</location>
--          </plugin>
--          <!-- You can also specify a local path -->
--          <plugin>
--            <location>/path/to/some-plugin.jar</location>
--          </plugin>
--        </plugins>
--      </pluginManagement>
--    </bootstrap>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22
--
--Supported plugin sources:
--
--* Store coordinate:
--  * `store:/1ce83c47-7b8d-4da8-844e-723cf5e3c426/2.0.7`(no double slash!)
--  * in general: `store://[itemKey]/[version]/[fileName]?store=[storeKey]&server=[baseUrl]`
--  * only the `itemKey` and `version` are required
--* Maven coordinate
--  * `-DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22`
--* File:
--  * `-DaddSystemPlugins=/home/user/Downloads/myPlugin.jar`
--* URL:
--  * `-DaddSystemPlugins=https://example.com/plugin.jar`
--
--### Use a different or no license
--
--By default, a demo license is used. To use a different license:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <licenseFile>/path/to/license.lic</licenseFile>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:ms -DlicenseFile=/path/to/license.lic
--
--Sometimes you may want to start the server without a preinstalled license:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <licenseFile>builtin:none</licenseFile>
--  </configuration>
--</plugin>
--```
--
--The value for `licenseFile` can be either
--* a file path
--  * `file:/path/to/license.lic`
--* a file URI
--  * `file:/path/to/license.lic`
--* a builtin URI:
--  * `builtin:<name>`
--    * `builtin:demo` Uses a simple demo license.
--    * `builtin:none` Uses no license.
--
--### Deploy current plugin project on startup
--
--By default, the `run-ms-war` goal checks whether the current Maven project is a
--[FORMCYCLE plugin project](#terms). If so, it automatically picks up the main artifact file
--of the project and installs the plugin after the FORMCYCLE app was started.
--
--To configure this behavior, add the following configuration in your pom:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <deployMavenProject>true</deployMavenProject>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:run-ms-war -DdeployMavenProject=false
--
--### Include additional dependencies
--
--Sometimes you may want to include additional dependencies in the classpath, e.g. for custom servlet container
--providers or database drivers.
--
--You can add additional dependencies on a per-execution basis like this:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <executions>
--    <execution>
--      <goals>
--        <goal>run-ms-war</goal>
--      </goals>
--      <phase>package</phase>
--      <configuration>
--        <dependencies>
--          <dependency>
--            <groupId>com.ibm.db2</groupId>
--            <artifactId>jcc</artifactId>
--            <version>11.5.8.0</version>
--          </dependency>
--        </dependencies>
--      </configuration>
--    </execution>
--  </executions>
--</plugin>
--```
--
--You can also use specify this setting on the command line (separate multiple dependenies with a comma):
--
--> mvn fc-server:run-ms-war -DaddDependencies=com.ibm.db2:jcc:com.ibm.db2
--
--### Skip execution for multi-module projects
--
--By default, the `run-ms-war` goal skips execution when run on a Maven project that is not a
--[FORMCYCLE plugin project](#terms). This can be useful e.g. when you have a multi-module project
--where only one project is a FORMYCLE plugin. You can then simply invoke `mvn fc-server:run-ms-war`
--on the parent project. This builds the entire project until it reaches the FORMCYCE plugin, at which
--point it starts the server and installs the built plugin.
--
--To disable this default behavior, use `-DskipNonPluginProject=false` or use the following configuration in your pom:
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <skipNonPluginProject>true</skipNonPluginProject>
--  </configuration>
--</plugin>
--```
--
--You can also force the execution to be always skipped via the `skip` parameter in your pom:
--
--
--```xml
--<plugin>
--  <groupId>de.xima.fc.maven.plugin</groupId>
--  <artifactId>fc-server-maven-plugin</artifactId>
--  <version>${fc-server-maven-plugin.version}</version>
--  <configuration>
--    <skip>true</skip>
--  </configuration>
--</plugin>
--```
--
--You can also use specify this setting on the command line:
--
--> mvn fc-server:run-ms-war -Dskip.fc.server
--
--### Remote debugging
--
--To remote debug the the application server, start it with
--
--> MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1044  mvn fc-server:ms
--
--Then attach the debugger to port 1044.
--
--Note: When you start this goal from within your IDE, you usually do no need to specify this manually
--as your IDE will usually  attach to the JVM process automatically already.
--

README.md

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.awa

Größe

...	...	@@ -1,0 +1,1 @@
	1	+15.7 KB

Inhalt

@@ -1,0 +1,526 @@
++Maven plugin for starting a FORMCYCLE server, similar to the Jetty maven plugin, but initializes the FORMCYCLE application.
++
++## TL;DR
++
++Version 8:
++
++```bash
++# Standalone
++mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0:ms -DxfcVersion=8.0.4
++
++# FORMCYCLE plugin project
++mvn fc-server:run-ms-war
++```
++
++Version 7:
++
++> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
++
++See [changelog](./CHANGELOG.md) for a list of versions.
++
++## Table of contents
++
++[[_TOC_]]
++
++## Versioning
++
++* The major and minor version are always equal to the FORMCYCLE major version against which the project was built.
++* The patch version is for the plugin.
++
++## Building
++
++```bash
++mvn clean install
++```
++
++## Release
++
++* Update version via `mvn versions:set -DnewVersion=1.2.3`
++* Add release notes to `CHANGELOG.md`
++* Upload code to github
++* `mvn clean deploy`
++* Add a tag `git tag -a 1.2.3` and push via `git push origin 1.2.3`
++* Set next development version `mvn versions:set -DnewVersion=1.2.4-SNAPSHOT`
++
++## Site
++
++```bash
++mvn site
++mvn site:stage
++```
++
++The open `target/staging/index.html` in a browser. See `target/staging/fc-server-maven-plugin/plugin-info.html`
++for the MOJO documentation.
++
++## Terms
++
++A "FORMCYCLE plugin project" is Maven project packaged as a fat jar, with a (possibly transitive)
++compile dependency on `de.xima.fc:fc-plugin-common` in the `provided` scope.
++
++A Maven project "packaged as a fat jar" is Maven project with its `packaging` set to `jar` and
++that includes a plugin execution for either the `maven-assembly-plugin` or the `maven-shade-plugin`.
++
++## Goals
++
++See the site above for more in-depth info.
++
++* `ms` Intended for use as a command line tool to start a server without a Maven project:
++  `mvn fc-server:ms`.
++* `run-ms-war` Intended for use as a command line tool to start a server on an existing
++  [FORMCYCLE plugin project](#terms): `mvn fc-server:ms`.
++* `start-ms-war` Goal for integration into an existing lifecycle defined in a pom.xml, should be
++  bound to a particular phase. Does not block by default.
++
++## Usage
++
++This is a Maven plugin with several goals. You can run it via the command line:
++
++```bash
++# When you have no Maven project
++mvn fc-server:ms
++
++# When you have an existing FORMYCLE plugin project
++mvn fc-server:run-ms-war
++```
++
++If the command is run from within an existing Maven project, it first packages the project, then starts the server and finally (if `-DdeployMavenProject=true` is set), installs the main artifact file of the Mavne project automatically into the started FORMCYCLE instance.
++
++The first command can be used in a directory without a Maven project.
++
++If the second command is run on an existing [FORMCYCLE plugin project](#terms), it first packages that project, then
++starts the server and finally installs the main artifact file of the Maven project automatically into the started
++FORMCYCLE instance.
++
++If Maven cannot find the plugin or you need to run a specific version of the plugin, you have to use the full coordinates:
++
++> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:8.0.0-SNAPSHOT:run-ms-war
++
++To get Maven to find the plugin without the full name, either add the plugin to `<plugin>` section of your `pom.xml` or add the following to the `~/.m2/settings.xml`:
++
++```xml
++<settings>
++  <pluginGroups>
++    <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
++  </pluginGroups>
++</settings>
++```
++
++If you want to configure the plugin, you can do so via a `<plugin>` section in the `pom.xml`. See the
++site above for documentation.  Below are some example configurations.
++
++### Use a different FORMCYCLE version
++
++The FORMCYCLE version defaults to the version against which the version of the plugin was built. The plugin major and minor version always follow the FORMCYCLE version, e.g. plugin version 7.0.9 will default to some `7.0.x` release of FORMCYCLE.
++
++To set the version of the FORMCYCLE app:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <xfcVersion>7.0.7</xfcVersion>
++  </configuration>
++</plugin>
++```
++
++Note that you can also use:
++
++> mvn fc-server:ms -DxfcVersion=7.0.7
++
++You may have to use a different version of the plugin for older FC versions (major and minor plugin version always follow the FC version)
++
++> mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:ms -DxfcVersion=7.0.16
++
++### Use a custom FORMCYCLE war file
++
++If you need to, you can also use a custom FORMCYCLE WAR file, e.g. a local build etc.
++
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <warFile>/path/to/formcycle.war</warFile>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -DwarFile=/path/to/formcycle.war
++
++### Change servlet container settings
++
++You can change the server context path and port:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <contextPath>form-server</contextPath>
++    <port>8099</port>
++  </configuration>
++</plugin>
++```
++
++You can also use specify these settings on the command line:
++
++> mvn fc-server:ms -DcontextPath=form-server -Dport=8090
++
++### Change app persistence directory
++
++All FORMCYCLE specific data such as the log files, configuration files or temporary files are stored in the application directory in the `target` folder. You can use a different app directory if you want.
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <appDir>${project.basedir}/xfc-server</appDir>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -DappDir=target/apps/xfc-server
++
++### Use a different servlet container
++
++By default, Jetty is used, but this can be changed:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <container>tomcat:9</container>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -Dcontainer=tomcat:9
++
++By default, supported values are currently
++
++* `jetty:10` - Jetty Servlet Container Version 10.x
++* `tomcat:9` - Apache Tomcat Version 9.x
++
++To use a custom container, include a `de.xima.servletcontainer.api.IServletContainerProvider` in
++the classpath and specify the corresponding name.
++
++### Use in-memory H2 database
++
++By default, the H2 database is stored in a file, so the data is persisted when you restart the server. But you can also use an in-memory database:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <h2Storage>ram</h2Storage>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -Dh2Storage=ram
++
++### Use a different database
++
++Include the driver via `dbDrivers` and configure the `database.properties`:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <dbDrivers>
++      <dbDriver>postgresql</dbDriver>
++	</dbDrivers>
++    <databaseProperties>
++      <properties>
++        <property>
++          <name>db.connection.dbms.shortname</name>
++          <value>postgresql</value>
++        </property>
++        <property>
++          <name>db.connection.jdbcurl</name>
++          <value>jdbc:postgresql://localhost:5432/my_database</value>
++        </property>
++        <property>
++          <name>db.connection.login.username</name>
++          <value>USERNAME</value>
++        </property>
++        <property>
++          <name>db.connection.login.password</name>
++          <value>PASSWORD</value>
++        </property>
++      </properties>
++    </databaseProperties>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line (separate multiple drivers with a comma):
++
++> mvn fc-server:ms -DaddDbDrivers=postgresql,h2 -DdbShortname=postgresql -DdbJdbcUrl=jdbc:postgresql://localhost:5432/my_database -DdbUsername=USERNAME -DdbPassword=PASSWORD
++
++Supported database drivers are
++
++* `h2`
++* `mariadb`
++* `mysql`
++* `oracle`
++* `postgresql`
++* `sqlserver`
++* `custom` (does not add any driver, add your own driver via `dependencies`)
++
++### Create default clients
++
++You can add additional clients to be created when the FORMCYCLE app starts. When the client exists already, it is updated with the configured settings. Clients are identified by their `name`.
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <bootstrap>
++      <clientManagement>
++        <!-- Do not create the default client -->
++				<excludeDefaults>true</excludeDefaults>
++        <clients>
++          <!-- Create a default client -->
++          <client>
++            <baseSettings>
++              <name>myforms</name>
++              <alias>Formular</alias>
++              <languageTag>de</languageTag>
++              <baseUrl>http://10.42.42.50/form-server</baseUrl>
++              <description>Client for testing forms</description>
++            </baseSettings>
++            <adminUser>
++              <userName>awa</userName>
++              <email>awa@xima.de</email>
++              <givenName>Andre</givenName>
++              <lastName>Wachsmuth</lastName>
++              <password>12345678</password>
++            </adminUser>
++          </client>
++        </clients>
++      </clientManagement>
++    </bootstrap>
++  </configuration>
++</plugin>
++```
++
++### Including additional plugins
++
++You can include additional plugins that should be installed after the FORMYCLE app was started:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <bootstrap>
++      <pluginManagement>
++        <plugins>
++          <!-- You can specify a Maven coordinate when the plugin is available via Maven -->
++          <plugin>
++            <location>de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22</location>
++          </plugin>
++          <!-- You can also specify a local path -->
++          <plugin>
++            <location>/path/to/some-plugin.jar</location>
++          </plugin>
++        </plugins>
++      </pluginManagement>
++    </bootstrap>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22
++
++Supported plugin sources:
++
++* Store coordinate:
++  * `store:/1ce83c47-7b8d-4da8-844e-723cf5e3c426/2.0.7`(no double slash!)
++  * in general: `store://[itemKey]/[version]/[fileName]?store=[storeKey]&server=[baseUrl]`
++  * only the `itemKey` and `version` are required
++* Maven coordinate
++  * `-DaddSystemPlugins=de.xima.fc.plugin:fc-plugin-bundle-leitfaden:2.0.22`
++* File:
++  * `-DaddSystemPlugins=/home/user/Downloads/myPlugin.jar`
++* URL:
++  * `-DaddSystemPlugins=https://example.com/plugin.jar`
++
++### Use a different or no license
++
++By default, a demo license is used. To use a different license:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <licenseFile>/path/to/license.lic</licenseFile>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:ms -DlicenseFile=/path/to/license.lic
++
++Sometimes you may want to start the server without a preinstalled license:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <licenseFile>builtin:none</licenseFile>
++  </configuration>
++</plugin>
++```
++
++The value for `licenseFile` can be either
++* a file path
++  * `file:/path/to/license.lic`
++* a file URI
++  * `file:/path/to/license.lic`
++* a builtin URI:
++  * `builtin:<name>`
++    * `builtin:demo` Uses a simple demo license.
++    * `builtin:none` Uses no license.
++
++### Deploy current plugin project on startup
++
++By default, the `run-ms-war` goal checks whether the current Maven project is a
++[FORMCYCLE plugin project](#terms). If so, it automatically picks up the main artifact file
++of the project and installs the plugin after the FORMCYCLE app was started.
++
++To configure this behavior, add the following configuration in your pom:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <deployMavenProject>true</deployMavenProject>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:run-ms-war -DdeployMavenProject=false
++
++### Include additional dependencies
++
++Sometimes you may want to include additional dependencies in the classpath, e.g. for custom servlet container
++providers or database drivers.
++
++You can add additional dependencies on a per-execution basis like this:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <executions>
++    <execution>
++      <goals>
++        <goal>run-ms-war</goal>
++      </goals>
++      <phase>package</phase>
++      <configuration>
++        <dependencies>
++          <dependency>
++            <groupId>com.ibm.db2</groupId>
++            <artifactId>jcc</artifactId>
++            <version>11.5.8.0</version>
++          </dependency>
++        </dependencies>
++      </configuration>
++    </execution>
++  </executions>
++</plugin>
++```
++
++You can also use specify this setting on the command line (separate multiple dependenies with a comma):
++
++> mvn fc-server:run-ms-war -DaddDependencies=com.ibm.db2:jcc:com.ibm.db2
++
++### Skip execution for multi-module projects
++
++By default, the `run-ms-war` goal skips execution when run on a Maven project that is not a
++[FORMCYCLE plugin project](#terms). This can be useful e.g. when you have a multi-module project
++where only one project is a FORMYCLE plugin. You can then simply invoke `mvn fc-server:run-ms-war`
++on the parent project. This builds the entire project until it reaches the FORMCYCE plugin, at which
++point it starts the server and installs the built plugin.
++
++To disable this default behavior, use `-DskipNonPluginProject=false` or use the following configuration in your pom:
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <skipNonPluginProject>true</skipNonPluginProject>
++  </configuration>
++</plugin>
++```
++
++You can also force the execution to be always skipped via the `skip` parameter in your pom:
++
++
++```xml
++<plugin>
++  <groupId>de.xima.fc.maven.plugin</groupId>
++  <artifactId>fc-server-maven-plugin</artifactId>
++  <version>${fc-server-maven-plugin.version}</version>
++  <configuration>
++    <skip>true</skip>
++  </configuration>
++</plugin>
++```
++
++You can also use specify this setting on the command line:
++
++> mvn fc-server:run-ms-war -Dskip.fc.server
++
++### Remote debugging
++
++To remote debug the the application server, start it with
++
++> MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1044  mvn fc-server:ms
++
++Then attach the debugger to port 1044.
++
++Note: When you start this goal from within your IDE, you usually do no need to specify this manually
++as your IDE will usually  attach to the JVM process automatically already.
++