This site are is “work in progress” and will remain as such for a long time. As our time allows.
This section is where the user documentation for our project lives - all the information You need to understand and successfully use our projects.
This is the multi-page printable view of this section. Click here to print.
This site are is “work in progress” and will remain as such for a long time. As our time allows.
This section is where the user documentation for our project lives - all the information You need to understand and successfully use our projects.
All the Maveniverse projects were built with well-defined purpose and goal: to help and guide Maven users.
TBD
We are delighted to get contributions!
TBD
Maveniverse MIMA is very first project of ours.
A library that allows you to use Maven Resolver wherever you are.
Toolbox was started as a “showcase” project of Maveniverse MIMA combined into Mojos and CLI commands, that never stopped growing.
A tool that gives you Swiss Knife for every situation.
Nisse was a response to “finish” CI Friendly implementation in Maven 3, but turned out to be more.
An extension that makes things right.
A Maven Plugin for BOMs to build according to your own taste.
A plugin that helps you building BOM by your own taste.
A new project that makes POMs written in YAML, JSON, HOCON and TOML possible with all the whistle and bells.
A Maven 4 sugar:
Maveniverse Mímir started as solution of my own problem: workstation hopping, and a LOT of download when when picking up where I left on.
A Maven 3/4 extension that offers “global cache” on workstation, and shares cache via LAN to other Mimir running nodes.
Mímir is on Github: https://github.com/maveniverse/mimir
Mímir is a Maven 3 and Maven 4 extension that offers global caching on workstations. More precisely, Mímir is a
Resolver 1.x and 2.x extension (is a RepositoryConnector
)
that is loaded via Maven extensions mechanism and extends Resolver.
As you may know, Maven historically uses “local repository” as mixed bag, to store cached artifacts fetched from remote along with locally build and installed artifacts. Hence, your local repository usually contains both kind of artifacts.
Mímir alleviates this, by introducing a new workstation wide read-through cache (by default in ~/.mimir/local
) and placing
hardlinks in Maven local repository pointing to Mímir cache entries. This implies several important things:
Also some consequences are:
Advanced features of Mímir is LAN-wide cache sharing, so if you hop from workstation to workstation on same LAN, you don’t need to pull everything again, as your build will get it from the workstation that already has it. Nowadays with Gigabit LANs combined with modern WiFi networks, doing this is usually faster, than going to Maven Central.
In short: you want to use it for proper local repository maintenance, but it also helps with disk space usage as well, and real workstation wide caching, irrelevant of how many local repositories you use.
Finally, if you workstation-hop a lot (like I do) on same LAN, it makes pretty much sense to pick up on the new workstation where you left off on old workstation.
On CI-like setups it also simplifies caching between jobs, as all you need is to store Mímir cache after job finishes, and on subsequent job runs just restore it.
Simplest way to use Mímir is with Maven 4, it supports user wide extensions. Just create ~/.m2/extensions.xml
with following content (adjust Mímir version as needed):
<?xml version="1.0" encoding="UTF-8"?>
<extensions>
<extension>
<groupId>eu.maveniverse.maven.mimir</groupId>
<artifactId>extension</artifactId>
<version>0.4.1</version>
</extension>
</extensions>
Using it with Maven 3 is also possible and completely fine and compatible, but there you will need to set up
per-project extensions in .mvn/extensions.xml
file instead of one user-wide one.
One extra step is needed, in case you have non-trivial networking (like Docker, Tailscale or alike): you need
to “help” a bit to JGroups, to figure out which networking interface belongs to your LAN. To achieve that,
you need to create ~/.mimir/daemon.properties
file with following content (use your LAN IP address):
mimir.jgroups.interface=match-address\:192.168.1.*
This will help JGroups to properly bind to interface that is used on your LAN.
With these, you are fully set up. Now just go and fire up a Maven or Maven Daemon build.
TBD: explain how is Mímir used in Maven GH CI
Njord is an attempt to bring simple “publishing” (new term, is not “deploying with a twist”) to Maven 3 and Maven 4 with some extras like “local staging”.
A tool that handles repository operations for you.