How do I include configuration files with Maven Appassembler?

Question

I'm using the Maven Appassembler plugin to package my application. I'd like to package some configuration files with the application. I've found the configurationDirectory and includeConfigurationDirectoryInClasspath parameters, but I haven't found how I should create (and populate) that configuration directory. I've tried putting the files in src/main/resources, but that just puts them in the jar file for my project.

What is the "proper" way to do this, using maven?

score 6 · Accepted Answer · edited Oct 16 '20 at 07:36

Unfortunately this is a limitation of the appassembler plugin in the current release version. Typically, the plugin is used in conjunction with the assembly plugin to produce the final artifact, in which you can include the reference to your configuration directory. However, if you'd like to have a functional structure from just the appassembler plugin you need to manually copy the files into place. An example using the antrun plugin with a src/main/conf directory can be found here: http://svn.apache.org/viewvc/archiva/trunk/archiva-jetty/

score 2 · Answer 2 · answered Jan 03 '11 at 18:37

2

By default, the plugin uses the directory src/main/config.

Is possible to change the source for the config files using the parameter <configurationSourceDirectory>src/main/config</configurationSourceDirectory>

answered Jan 03 '11 at 18:37

jassuncao

4,695
3
30
35

This is the real answer together with adding `true`. – Benny Bottema Dec 23 '18 at 20:06

score 1 · Answer 3 · answered Jan 15 '11 at 04:02

1

When I include the copyConfigurationDirectory property, it copies the config files and bundles them properly.

  <configurationDirectory>etc</configurationDirectory>
  <configurationSourceDirectory>src/main/config</configurationSourceDirectory>
  <copyConfigurationDirectory>true</copyConfigurationDirectory>

I have a different problem though. I would like to filter my config files before copying, which is giving me some trouble.

answered Jan 15 '11 at 04:02

jon077

10,303
11
39
37

I have the same requirement but failed to find a solution to this – Jasonw Aug 05 '15 at 15:13

score 0 · Answer 4 · answered Feb 15 '10 at 19:41

Apart from that is does not generate the bin scripts for different platforms. The maven-assembly-plugin can create (package(s) {tar.gz, zip}) for distribution. These are configured through a assemble.xml. You specify which files go in (with what options (chmod)), etc. It can also filter files (search/replace values within them). etc.

score 0 · Answer 5 · answered Apr 05 '17 at 13:14

Years later and in version 1.10 of the plugin there is now a preAssembleDirectory configuration option. Unfortunately I don't find it flexible enough for my needs because it copies directly into assembleDirectory and does not allow to specify a target directory path within assembleDirectory.

How do I include configuration files with Maven Appassembler?

5 Answers5