Getting Started

Repository Setup

You can find the latest versions of Irontools projects in the Changelog page.

Maven

Add repository configuration to your pom.xml:

<repositories>
  <repository>
    <id>irontools-repo</id>
    <url>https://repo.irontools.dev/releases</url>
  </repository>
</repositories>

Add dependencies to your pom.xml:

Iron Serde:

<dependency>
    <groupId>dev.irontools</groupId>
    <artifactId>iron-serde</artifactId>
    <version>${irontools.version}</version>
</dependency>

Iron Functions:

<dependency>
    <groupId>dev.irontools</groupId>
    <artifactId>iron-functions</artifactId>
    <version>${irontools.version}</version>
</dependency>

Gradle

Add repository configuration to your build.gradle:

repositories {
    maven {
        url = uri("https://repo.irontools.dev/releases")
    }
}

Add dependencies to your build.gradle:

Iron Serde:

dependencies {
    implementation "dev.irontools:iron-serde:${irontoolsVersion}"
}

Iron Functions:

dependencies {
    implementation "dev.irontools:iron-functions:${irontoolsVersion}"
}

License Configuration

Irontools projects require a valid license to operate. Contact us to get a free trial license. The license can be configured in several ways:

Environment Variables

# Option 1: Direct license string
export IRONTOOLS_LICENSE=your-license-string

# Option 2: Path to license file
export IRONTOOLS_LICENSE_PATH=/path/to/license/file

Java System Properties

# Option 1: Direct license string
java -Dirontools.license=your-license-string ...

# Option 2: Path to license file
java -Dirontools.licensePath=/path/to/license/file ...

Best Practices

  1. For development environments, use environment variables or system properties.
  2. For production deployments, consider using a license file in a secure location.
  3. When using the Ironfun CLI tool, you can include the license in the generated JAR using the --include-license option.
  4. For CI/CD pipelines, store the license as a secret and pass it via environment variables.