| 1 | # fontoxml-development-tools-module-connectors
|
| 2 |
|
| 3 | This module can be used with the development tools for FontoXML, it contains command for building and running a connectors instance.
|
| 4 |
|
| 5 | ## Prerequisites
|
| 6 |
|
| 7 | This module requires the following to be installed:
|
| 8 |
|
| 9 | - FontoXML license
|
| 10 | - FontoXML development tools
|
| 11 | - Docker
|
| 12 |
|
| 13 | ## Installation
|
| 14 |
|
| 15 | This module is part of the FontoXML development tools and is not meant to be used separately. To install the FontoXML development tools, run the following command:
|
| 16 |
|
| 17 | npm i -g @fontoxml/fontoxml-development-tools
|
| 18 |
|
| 19 | ### Usage examples
|
| 20 |
|
| 21 | fdt connectors init --version <version> [--location <path>]
|
| 22 |
|
| 23 | Initialize a new connectors instance.
|
| 24 |
|
| 25 | fdt connectors upgrade --version <version> [--location <path>]
|
| 26 |
|
| 27 | Upgrade the connectors instance to the specified version.
|
| 28 |
|
| 29 | We recommend you to complete the connectors instance using the [Getting started guide](http://documentation.fontoxml.com/display/FC/Getting+started).
|
| 30 |
|
| 31 | fdt connectors run [--location <path>] [--connectors-config-location <path>] [--verbose] [--debug]
|
| 32 |
|
| 33 | Run to test the configuration.
|
| 34 |
|
| 35 | fdt connectors build [--location <path>] [--image-name <image-name>] [--image-tag <image-tag>] [--verbose] [--debug]
|
| 36 |
|
| 37 | Build a production image.
|