Getting Started

Getting started

Milo runs on Java 17 or later. Add the client or server SDK to your application, then use the examples to explore the API.

The new Wiki guide targets 1.2.0-SNAPSHOT. The 1.1.7 release is available for applications that need a released version; its API differs from the 1.2 preview. See the 1.2.0 migration guide when upgrading.

Dependencies

Choose the SDK your application needs. This example uses the 1.2 preview client:

<dependency>
    <groupId>org.eclipse.milo</groupId>
    <artifactId>milo-sdk-client</artifactId>
    <version>1.2.0-SNAPSHOT</version>
</dependency>

For a server, use milo-sdk-server instead. For the 1.1.7 release, use 1.1.7 as the version. Releases are available from Maven Central. Keep all Milo dependencies at the same version; milo-bom can manage versions when using several Milo artifacts.

Snapshot repository

The 1.2 preview also requires this repository in your POM:

<repositories>
    <repository>
        <id>sonatype-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

Snapshots change as development continues. Source links in the topic pages pin the code used when preparing the outline; the snapshot repository may contain a later build.

Run an example

Follow the client example instructions and the example index. Many client examples use ClientExampleRunner, which starts an example server in the same process and configures mutual trust. Examples for external servers list their own prerequisites in the source.

The first-client and first-server tutorials are outlined but are still being written. Their pages link to the existing runnable examples.

Next steps

• OPC UA concepts
• Client SDK
• Server SDK
• Building Milo from source