Skip to content

Offline installs

By default a Controller makes two kinds of outbound connections, and no others:

  • the hourly sync of the signed catalog from catalog.shardkeep.gg;
  • downloads of server software and plugins from their publishers, when a server needs a version not yet in its cache.

Start the Controller with -offline to turn both off. Add it to the Controller’s command in compose.yml.

Offline, server software and plugins come only from what you upload:

  • Server software: a global administrator uploads it through the API (POST /artifacts, at most 512 MiB). Uploads are marked unverified.
  • Plugins: upload the jar on the server’s Plugins section.

Software already in the Controller’s cache keeps working.

Instead of going fully offline, you can mirror the catalog: it is a set of static, signed files that any web server can host. Point the Controller at your mirror with -catalog-url. To serve a catalog you sign yourself, add your public key with -catalog-trust-key. See Controller flags.