search

dazraf / vertx-hot

A Maven plugin for hot-deploy of Vert.x projects
47 stars 9 forks source link

Whats in config.json? #4

Closed jymboche closed 9 years ago

jymboche commented 9 years ago

Thanks for this! Just started using Vertx and this was the first/easiest solution that seems to work for me.

I cant seem to find anything on a json config file. What are the options for this file? I created a file with an empty json file and it seems to run without error.

dazraf commented 9 years ago

Hello! Thanks for the question. Hopefully I've understood it correctly.

Background on Vert.x Verticles and Verticle config files

A vert.x container runs verticles (they can be thought of as micro services). Starting a verticle is fairly simple. See the docs

A verticle can be started with a config file. The contents of that config file is entirely decided by the verticle developer. It can contain anything.

The plugin just gives a way of referencing such a config file, if the developer has one. In the plugin config xml, you can have any of the following:

<configuration>
  <verticleClassName>MyVerticle</verticleClassName>
  <configFile>myconfig.json</configFile>
</configuration>

or 

<configuration>
  <verticleClassName>MyVerticle</verticleClassName>
</configuration>

or

<configuration>
  <verticleClassName>MyVerticle</verticleClassName>
  <configFile></configFile>
</configuration>

Does that help? regards

dazraf commented 9 years ago

I've closed this for now. Let me know if any further questions.