Use in App Project

...

Document Properties Marker

override	false

Short Description

Shows how to add the Apptools Maven Plugin to your Confluence add-on project.

Doctype

topic

hide

Name

Configure Use in App Project

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

BASIC-0010-0010

hide

Section

show-title	false
title	Description

The following shows a configuration where the different target environments are configured with the POM file. This makes the different environments immediately accessible to users of the project.

Unfortunately this configuration lacks flexibility in case you administrate more than one project. In this case you may want to check the alternative configuration we show at the end of this tutorial.

Section

title	Summary

Section

title	Prerequisites

...

Section

title	Basic Configuration

Simply add the configuration to the POM file of your project.

projectdoc-content-marker

id	basic-config-xml

projectdoc-code-block-placeholder-macro

code-language	HTML and XML
code-title	pluginManagement in pom.xml

<build>
  ...
  <pluginManagement>
    <plugins>
      ...
      <plugin>
        <groupId>de.smartics.maven.plugin</groupId>
        <artifactId>apptools-maven-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <sourceFolder>\${basedir}/target</sourceFolder>
          <includes>
            <include>\${project.artifactId}$</include>
          </includes>
          <acceptedFilenameExtensions>
            <extension>obr</extension>
          </acceptedFilenameExtensions>
        </configuration>
      </plugin>
    </plugins>
  </pluginManagement>
  ...
</build>

Section

title	Configure local Server

Then add profiles to configure the Confluence servers you want to deploy to.

The following shows the deployment to the locally started Confluence on a developer machine (with default password and user admin).

Code Block

language	xml
title	profile in pom.xml

<profiles>
  <profile>
    <id>LOCAL</id>
    <activation>
      <activeByDefault />
    </activation>
    <build>
      <pluginManagement>
        <plugins>
          <plugin>
            <groupId>de.smartics.maven.plugin</groupId>
            <artifactId>apptools-maven-plugin</artifactId>
            <configuration>
              <username>admin</username>
              <password>admin</password>
              <serverUrl>http://localhost:1990/confluence</serverUrl>
            </configuration>
          </plugin>
        </plugins>
      </pluginManagement>
    </build>
  </profile>
  ...
</profiles>

Then deploy the OBR artifact to the local server by specifying the profile.

Code Block
mvn apptools:deploy -PLOCAL

Use the extension jar, if your app is not bundled in an OBR.

In case you want to deploy to a remote test server, add a profile like this:

Transclusion

render-document-name-as-heading	true
taget-heading-level	*
document	Configure Servers
ids	*,!p_for_build_profiles,!Resources,!References
tags	!additional_help

Section

title	Configure remote Server

Code Block

language	xml
title	profile in pom.xml

    <profile>
      <id>TEST</id>
      <build>
        <pluginManagement>
          <plugins>
            <plugin>
              <groupId>de.smartics.maven.plugin</groupId>
              <artifactId>apptools-maven-plugin</artifactId>
              <configuration>
                <serverId>confluence-test</serverId>
                <serverUrl>${my.server.url.TEST}</serverUrl>
              </configuration>
            </plugin>
          </plugins>
        </pluginManagement>
      </build>
    </profile>

Provide the credentials and the URL to access the TEST server in your settings.xml.

Code Block

language	xml
title	~/.m2/settings.xml

<settings> ... <servers> ... <server> <id>confluence-test</id> <username>jane.doe</username> <password>{HllO1A....}</password> </server> </servers> ... <profiles> <profile> <my.server.url.TEST>https://www.mycorp.example.com/confluence</my.server.url.TEST> </properties> </profile> ... </profiles> </settings>

Section

title	Subordinate Topics

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	Resources

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Usage
Use in POM Project

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 2

New Version Current

Key

About

Keep up-to-date!

Powered by