Common Prerequisites
These prerequisites apply to every self-managed installation method. Review them before following the AWS (Helm), Azure (Helm), or Embedded Cluster guide, each of which adds its own platform-specific requirements on top of these.
Provided by JuliaHub
Contact your JuliaHub sales representative to obtain your licensing credentials. What you receive depends on the installation method:
Helm installations (AWS, Azure) — a license ID and license email, used as the password and username when logging in to the Helm registry. The chart carries the license values itself, so there is no separate license file to install.
Embedded Cluster — a license file (
license.yaml) and a license ID, uploaded during installation.
Your license also determines your entitlements, such as whether compute (batch jobs and interactive applications) is enabled.
The package server token is part of your license
Your installation authenticates to JuliaHub's package servers using a token carried in the license, so there is nothing to enter by hand and synchronization enables itself once the license is in place. See Admin Settings.
Initial administrator account
JuliaHub authenticates users through single sign-on, and that is how accounts should be managed on a running installation. But configuring an identity provider requires an administrator who can already sign in, so every installation is bootstrapped with one administrator account to start from.
Decide the email address that should own it before you begin. How you supply it depends on the installation method:
Embedded Cluster — set Administrator Email Address and Administrator Password in the Initial Administrator section of the Admin Console configuration screen. The password field is pre-filled with a randomly generated value; keep it or replace it with your own, and record it before continuing.
Helm installations (AWS, Azure) — set
settings.initialUsersin your Helm values, with a bcrypt-hashed password:yamlsettings: initialUsers: - name: Ada Lovelace email: ada@example.com role: admin bcryptPasswordHash: "<hash>"Generate the hash with
htpasswd -bnBC 10 "" <password> | tr -d ':\n'.
Once single sign-on is configured, add and manage users through your identity provider rather than creating further local accounts — local accounts cannot reset their own passwords.
Installing with single sign-on already configured
If you configure an identity provider as part of the installation, the administrator does not need a local password at all. Clear the Administrator Password field (or omit bcryptPasswordHash from your Helm values) and the account is still created with administrator access, but signs in only through your provider.
Set the email address to one your provider will present for that person, so that their first single sign-on login lands on this account rather than creating a second one.
Record the password
The initial password cannot be read back out of JuliaHub after installation, only replaced. These settings apply only when the account is first created — changing them later has no effect on an installation that has already been bootstrapped. Change it afterwards from Administration ➤ Server Configuration inside JuliaHub.
Provided by you
Hostname
Decide the hostname your installation will be reached at (referred to as <hostname> throughout these guides). It does not need to resolve yet, but it must be chosen before you begin, as it is baked into the TLS certificate and the platform configuration.
TLS certificate and private key
A certificate and key in PEM format covering both:
<hostname>— the main platform URLdocs.<hostname>— generated Julia package documentation
The certificate must include the full CA chain.
DNS records
A (or CNAME) records for <hostname> and docs.<hostname>, pointing at the machine or load balancer that fronts the installation. These are created after the install completes, once you know the ingress address.
PostgreSQL database (optional)
JuliaHub requires PostgreSQL. You may either let the installation provision an internal database, or point it at an existing server. An external server must require SSL and present a valid certificate, and you must create an empty database for JuliaHub to use.
An internally provisioned database is not reachable from outside the cluster.
Git host (optional)
Private registries and private packages require network connectivity to a Git platform. Self-hosted GitHub, GitLab, and Bitbucket are supported, as are their respective cloud services. See Registry Management.
Internal CA certificates (optional)
If your environment terminates or inspects TLS with an internal certificate authority, collect the CA certificates for:
any internal GitHub or GitLab instance used as a private package registry
any internal HTTP/HTTPS proxy
Concatenate them into a single PEM-encoded file, with a newline between certificates.
Outbound network access
Installations that are not air-gapped need outbound TCP 443 to the following hosts. If your environment restricts egress, allowlist them before installing.
| Host | Required | Purpose |
|---|---|---|
pkg.juliahub.com, juliahub.com | Yes | Package, documentation, and artifact synchronization. |
replicated.app | Yes | Application metadata and release YAML, and instance reports from the Replicated SDK. Your license ID and application ID are sent to authenticate. |
proxy.replicated.com | Optional | Proxies the JuliaHub application container images. Authenticated with your license ID. |
auth.docker.io, registry-1.docker.io, index.docker.io, dseasb33srnrn.cloudfront.net, production.cloudflare.docker.com | Optional | Some installer dependencies are hosted as public Docker Hub images. |
replicated.app and proxy.replicated.com are operated by Replicated, Inc. The current IP ranges for both are published at replicatedhq/ips.
Using an internal registry instead
The optional hosts above can be avoided by mirroring the images through an internal registry such as Artifactory, or by using an air-gapped installation. See the air-gap section of your chosen installation guide, and Offline Package Bundles for supplying packages without internet access.
On a Helm installation, the mirror also needs the Replicated SDK image, proxy.replicated.com/library/replicated-sdk-image. See Instance Reporting below.
Instance reporting
From JuliaHub 26.6, every installation runs a small replicated Deployment alongside the platform: the Replicated SDK. It checks in with replicated.app about every four hours, and whenever the platform's status changes or it is upgraded. Each check-in reports the installed JuliaHub version, whether the core JuliaHub services are ready, and basic cluster details: the Kubernetes version and distribution, and the cloud provider and region. JuliaHub uses this to see which versions its customers run and to spot unhealthy installations before you report them. The SDK sends no user, package, project, or job data. Its Kubernetes role is confined to the JuliaHub namespace: it can list pods and read the JuliaHub workloads it reports on, and the only Secrets it can read are its own.
Embedded Cluster installations configure the SDK from the Admin Console: it uses the Proxy Settings values, and it stops reporting when the installation is air-gapped or Air Gap Environment is enabled. On a Helm installation, set these in your values file instead.
Behind an HTTP proxy. The SDK cannot read the chart's top-level httpsProxy, so repeat the proxy URL for it. It supports a proxy URL only, with any credentials URL-encoded in it. It does not support httpProxyAuthMethod schemes such as NTLM.
replicated:
proxy:
httpsProxy: "http://proxy.example.com:3128"
noProxy: ""Without access to replicated.app. Turn on air-gap mode. The SDK then makes no outbound connections and keeps its reports in a Secret that is included in support bundles. Without this setting, the replicated pod never becomes ready, and helm install --wait waits for it until it times out.
replicated:
isAirgap: trueMirroring images. If you mirror the JuliaHub images into your own registry, mirror proxy.replicated.com/library/replicated-sdk-image too, and point the SDK at the copy. The setting for the platform images (images.registry) does not apply to it. The tag the chart expects shows up when you render it:
helm template juliahub-platform \
oci://registry.replicated.com/juliahub/production/juliahub-platform \
--version <version> --set hostname=example.com | grep replicated-sdk-imagereplicated:
image:
registry: "artifactory.example.com"
repository: "juliahub-mirror/replicated-sdk-image"
# Only if your registry needs credentials:
imagePullSecrets:
- name: "<pull-secret-name>"Turning it off. A setting on your JuliaHub license controls whether the SDK runs. To run without instance reporting, contact JuliaHub support and we will turn it off on your license.
The change takes effect at your next upgrade. On a Helm installation, that is your next helm upgrade. On Embedded Cluster, it is the next deploy after the Admin Console syncs your license. After that, JuliaHub has no view of the installation until you send a support bundle.
Next steps
Once these are in place, continue with the guide for your target environment: