Have a question? Want to report an issue? Contact JFrog support

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

There are three main ways you can use Docker with Artifactory and this document describes how to get started with each one.

Please review the brief summary below to decide which is the best way for you to use Docker with Artifactory.

Artifactory SaaS

The easiest way to start using Docker with Artifactory is through an Artifactory SaaS account.

In this mode, since Artifactory is a hosted service, you do not need to set up a reverse proxy and can create your Docker repositories and start pushing and pulling Docker images.

For more details, please refer to Getting Started with Artifactory SaaS.

Using Docker Compose - 1 Minute Setup

Artifactory can be run in a Docker container preconfigered as a Docker registry.

For more details, please refer to Using Docker Compose - 1 Minute Setup.

Artifactory On-Prem

You can setup your on-prem installation of Artifactory Pro to work with Docker.

The Docker client requires a different hostname for each registry. Artifactory supports this whether you are using a reverse proxy or not.

For more details, please refer to Getting Started with Artifactory Pro On-Prem.

Panel
titlePage Contents

Table of Contents
maxLevel4
minLevel2
 


Getting Started with Artifactory SaaS

Using Docker repositories with Artifactory SaaS is quick and easy to use. 

Since, with Artifactory SaaS, you are using Artifactory as a hosted service, there is no need to configure Artifactory with a reverse proxy.

The example at the end of this section shows a complete process of creating a Docker repository, logging in, pulling an image and pushing an image.

Using Docker Client with Artifactory SaaS

To use the Docker client with one of your Artifactory SaaS Docker repositories, you can use the native Docker client to login to each Docker repository, pull, and push images as shown in the following example:

  • Login to your repository use the following command with your Artifactory SaaS credentials

    Code Block
    docker login ${server-name}-{repo-name}.jfrog.io
  • Pull an image using the following command

    Code Block
    docker pull ${server-name}-{repo-name}.jfrog.io/<image name>
  • To push an image, first tag it and then use the push command

    Code Block
    docker tag <image name> ${server-name}-{repo-name}.jfrog.io/<image name>
    docker push ${server-name}-{repo-name}.jfrog.io/<image name>

Test Your Setup

You can test your setup with this example that assumes you are using an Artifactory SaaS server named "acme".

The scenario it demonstrates is:

  • Pulling the "hello-world" Docker image
  • Logging into your virtual Docker repository
  • Retagging the "hello-world" image, and then pushing it into your virtual Docker repository

Start by creating a virtual Docker repository called dockerv2-virtual

  • Pull the "hello-world" image

    Code Block
    docker pull hello-world
  • Login to repository dockerv2-virtual

    Code Block
    docker login acme-dockerv2-virtual.jfrog.io
  • Tag the "hello-world" image

    Code Block
    docker tag hello-world acme-dockerv2-virtual.jfrog.io/hello-world
  • Push the tagged "hello-world" image to dockerv2-virtual

    Code Block
    docker push acme-dockerv2-virtual.jfrog.io/hello-world

Using Docker Compose - 1 Minute Setup

Artifactory may easily be installed as a Docker registry running in Docker. This is the easiest way to use Artifactory as a Docker registry on-premises. The installation spins up the following three containers:

  • Artifactory Pro
  • NGINX proxy that uses a self-signed certificate and is configured for access using the sub-domain method
  • A Postgres database

To spin up this installation run the following command:

Code Block
curl -L 'https://bintray.com/api/v1/content/jfrog/run/art-compose/$latest/art-compose?bt_package=art-compose' | sudo bash

Complete the Setup

To complete the setup, invoke the onboarding wizard by running Artifactory in your browser at http://<HOST_NAME>/artifactory

  • Activate Artifactory with your license key. If you do not have a license you can get a free 30 day Trial license
  • You may set the Admin password or skip to accept the default
  • If necessary, configure your network proxy or just skip this step (you may configure a proxy server at any time later)
  • At Create Repositories, select Docker and continue to complete the wizard
Info
titleSub-domains method

 We use this method so you will not need to change the reverse proxy configuration for each new Docker repository created. 

Finally, follow the steps below:

  1. You need to add the following to your DNS or /etc/hosts file:

    Code Block
    <ip-address> docker-local.artifactory docker-remote.artifactory docker-virtual.artifactory docker.artifactory artifactory
  2. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in the 

    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/#using-self-signed-certificates
    . Alternatively, you can configure the Docker client to work with an insecure registry by adding the following line to your /etc/default/docker file (you may need to create the file if it does not already exist):

    Code Block
    DOCKER_OPTS="$DOCKER_OPTS --insecure-registry docker-local.artifactory --insecure-registry docker-remote.artifactory --insecure-registry docker-virtual.artifactory --insecure-registry docker.artifactory"
  3. Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine).

Test Your Setup

You can test your setup with this example .

The scenario it demonstrates is:

  • Pulling the "hello-world" Docker image
  • Logging into your virtual Docker repository
  • Retagging the "hello-world" image, and the pushing it into your virtual Docker repository

The Artifactory Docker registry is already configured with a virtual repository called docker.artifactory.

  • Pull the "hello-world" image

    Code Block
    docker pull hello-world
  • Login to repository "docker.artifactory"

    Code Block
    docker login docker.artifactory
  • Tag the "hello-world" image

    Code Block
    docker tag hello-world docker.artifactory/hello-world
  • Push the tagged "hello-world" image to docker.artifactory

    Code Block
    docker push docker.artifactory/hello-world

Getting Started with Artifactory Pro On-Prem

The Docker client has the following two limitations:

  1. You cannot use a context path when providing the registry path (e.g localhost:8081/artifactory is not valid)
  2. Docker will only send basic HTTP authentication when working against an HTTPS host

Artifactory offers solutions to these limitations allowing you to create and use any number of Docker registries.

  • Using a reverse proxy
    When used, a reverse proxy, maps Docker commands to one of the multiple Docker registries in Artifactory
  • Without a reverse proxy
    From version 5.8, Artifactory supports using Docker without the use of a reverse proxy allowing you to create and use multiple Docker registries in Artifactory out-of-the-box. 

Using a Reverse Proxy

When using Artifactory with a reverse proxy, you need to map Docker commands to Docker registries in Artifactory using either the subdomain method or the ports method
Tip
titleTesting or evaluating?

 If you are currently only testing or evaluating using Artifactory with Docker, we recommend running Artifactory as a Docker container which is easily installed and comes with a proxy server and Docker registries pre-configured out-of-the-box. You can be up and running in minutes.

Reverse Proxy for Docker

With the ports method, a port number mapped to each Artifactory Docker registry. While this is an easy way to get started, you will need to modify your reverse proxy configuration and add a new mapping for each new Docker registry you define in Artifactory. In addition, firewalls and other restrictions by your IT department may restrict port numbers making the ports method not feasible. 

With the subdomain method, you only need to configure your reverse proxy once, and from then on, the mapping from Docker commands to Docker registries in Artifactory is dynamic and requires no further modification of your reverse proxy configuration.

We recommend to use the subdomain method since it will require one time effort.

The Subdomain Method

Getting started with  Docker and your on-prem Artifactory Pro installation using the subdomain method involves two basic steps:

  1. Configuring Artifactory and your reverse proxy. 

  2. Configuring your Docker client.

Anchor
anchorCfgRevProxySubdomain
anchorCfgRevProxySubdomain
Configuring Artifactory and Your Reverse Proxy

To configure Artifactory and your reverse proxy using the subdomain method, carry out the following steps:

  1. Make sure Artifactory is up and running, and is activated with a valid license
  2. Create your virtual Docker repository (as well as a local and remote Docker repository that it should aggregate). In our example below we will use a repository named docker-virtual
  3. Make sure you have a reverse proxy server up and running.
  4. Obtain a wildcard SSL certificate or use a wildcard self-signed certificate. 

    Note

    Make sure your certificate matches the Artifactory hostname used in your reverse proxy configuration. In our example below we will use art.local.

  5. Configure your reverse proxy. Artifactory's Reverse Proxy Configuration Generator can generate your complete reverse proxy configuration file for supported servers. All you need to do is fill in the fields in according to how your reverse proxy is set up while making sure to:

    1. Use the correct Artifactory hostname in the Public Server Name field (in our example this will be art.local)
    2. Select Subdomain as the Reverse Proxy Method under Docker Reverse Proxy Settings  

    NGINX
    Copy the code snippet generated by the configuration generator into your artifactory-nginx.conf file, and place it in your /etc/nginx/sites-available directory.
    Create the following symbolic link.

    Code Block
    sudo ln -s /etc/nginx/sites-available/artifactory-nginx.conf /etc/nginx/sites-enabled/artifactory-nginx.conf

    Apache HTTPD

    Copy the code snippet generated by the configuration generator into your artifactory-apache.conf file and place it in you /etc/apache2/sites-available directory. 

    Create the following symbolic link:

    Code Block
    sudo ln -s /etc/apache2/sites-available/artifactory-apache.conf /etc/apache2/sites-enabled/artifactory-apache.conf
Anchor
anchorCfgDockerClientSubdomain
anchorCfgDockerClientSubdomain
Configuring Your Docker Client 

To configure your Docker client, carry out the following steps 

  1. Add the following to your DNS or to the client's /etc/hosts file:

    Code Block
    <ip-address> docker-virtual.art.local 
  2. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in the 

    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/#using-self-signed-certificates
    . Alternatively, you can configure the Docker client to work with an insecure registry as described in the 
    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/
    .

     

  3. Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine).

Test Your Setup

To verify your reverse proxy is configured correctly, run the following command making sure that the return code is 200:

Code Block
curl -I -k -v https://<artifactory url>/api/system/ping

Run the following commands to ensure your proxy configuration is functional and can communicate with Artifactory:

  • Pull the "hello-world" image

    Code Block
    docker pull hello-world
  • Login to repository docker-virtual

    Code Block
    docker login docker-virtual.art.local
  • Tag the "hello-world" image

    Code Block
    docker tag hello-world docker-virtual.art.local/hello-world
  • Push the tagged "hello-world" image to docker-virtual

    Code Block
    docker push docker-virtual.art.local/hello-world

The Ports Method

Getting started with  Docker and your on-prem Artifactory Pro installation using the ports method involves two basic steps:

  1. Configuring Artifactory and your reverse proxy. 

  2. Configuring your Docker client.

Anchor
anchorCfgRevProxyPorts
anchorCfgRevProxyPorts
Configuring Artifactory and Your Reverse Proxy

To configure Artifactory and your reverse proxy using the ports method, carry out the following steps:

  1. Make sure Artifactory is up and running, and is activated with a valid license
  2. Create your virtual Docker repository (as well as a local and remote Docker repository that it should aggregate). In our example below we will use a repository named docker-virtual.
  3. Make sure you have a reverse proxy server up and running.
  4. Obtain an SSL certificate or use a Self-Signed certificate that can be generated following this example. 

    Note

    Make sure your certificate matches the Artifactory hostname used in your reverse proxy configuration. In our example below we will use art.local.

  5. Configure your reverse proxy. Artifactory's Reverse Proxy Configuration Generator can generate your complete reverse proxy configuration file for supported servers. All you need to do is fill in the fields in according to how your reverse proxy is set up while making sure to:
    1. Use the correct Artifactory hostname in the Public Server Name field 
    2. Select Ports as the Reverse Proxy Method under Docker Reverse Proxy SettingsIn the example below, we will use port 5001 to bind repository docker-virtual.
    NGINX

    For Artifactory to work with Docker, the preferred web server is NGINX v1.3.9 and above. 
    First, you need to create a self-signed certificate for NGINX 

    Newtablink
    Textas described here for Ubuntu
    URLhttps://www.digitalocean.com/community/tutorials/how-to-create-a-ssl-certificate-on-nginx-for-ubuntu-12-04
    .
    Then use Artifactory's Reverse Proxy Configuration Generator to generate the configuration code snippet for you.
    Copy the code snippet into your artifactory-nginx.conf file and place it in your /etc/nginx/sites-available directory.
    Finally, create the following symbolic link:

    Code Block
    sudo ln -s /etc/nginx/sites-available/artifactory-nginx.conf /etc/nginx/sites-enabled/artifactory-nginx.conf

    Apache HTTPD

    Newtablink
    TextInstall Apache HTTP server as a reverse proxy
    URLhttps://www.digitalocean.com/community/tutorials/how-to-use-apache-http-server-as-reverse-proxy-using-mod_proxy-extension
     and then install the 
    Newtablink
    Textrequired modules
    URLhttps://github.com/GCRC/nunaliit/wiki/Optionally-configuring-Apache2-as-a-reverse-proxy-virtual-host
    .

    Create the following symbolic link:

    Code Block
    sudo ln -s /etc/apache2/mods-available/slotmem_shm.load /etc/apache2/mods-enabled/slotmem_shm.load

    Similarly, create corresponding symbolic links for: 

    • headers
    • proxy_balancer
    • proxy_load
    • proxy_http
    • proxy_connect
    • proxy_html
    • rewrite.load
    • ssl.load
    • lbmethod_byrequests.load

    Then use Artifactory's Reverse Proxy Configuration Generator to generate the configuration code snippet for you.
    Copy the code snippet into your artifactory.conf file and place it in your /etc/apache2/sites-available directory.
    HAProxy
    First, you need to create a self-signed certificate for HAProxy 
    Newtablink
    Textas described here for Ubuntu
    URLhttps://www.vultr.com/docs/add-ssl-termination-to-haproxy-on-ubuntu
    .

    Then, copy the code snippet below into your /etc/haproxy/haproxy.cfg file. After editing the file as described in the snippet, you can test your configuration using the following command:

    Code Block
    haproxy -f /etc/haproxy/haproxy.cfg -c
    Code Block
    titleHAProxy v1.5 Configuration
    linenumberstrue
    collapsetrue
    # haproxy server configuration
    # version 1.0
    # History
    # ---------------------------------------------------------------------------
    # Features enabled by this configuration
    # HA configuration
    # port 80, 443  Artifactory GUI/API
    #
    # This uses ports to distinguish artifactory docker repositories
    # port 443  docker-virtual (v2) docker v1 is redirected to docker-dev-local.
    # port 5001 docker-prod-local (v1); docker-prod-local2 (v2)
    # port 5002 docker-dev-local (v1); docker-dev-local2 (v2)
    #
    # Edit this file with required information enclosed in <...>
    # 1. certificate and key
    # 2. artifactory-host
    # 3  replace the port numbers if needed
    # ----------------------------------------------------------------------------
    global
            log 127.0.0.1   local0
            chroot /var/lib/haproxy
            maxconn 4096
            user haproxy
            group haproxy
            daemon
            tune.ssl.default-dh-param 2048
            stats socket /run/haproxy/admin.sock mode 660 level admin
    defaults
            log     global
            mode    http
            option  httplog
            option  dontlognull
            option  redispatch
            option  forwardfor
            option  http-server-close
            maxconn 4000
            timeout connect 5000
            timeout client 50000
            timeout server 50000
            errorfile 400 /etc/haproxy/errors/400.http
            errorfile 403 /etc/haproxy/errors/403.http
            errorfile 408 /etc/haproxy/errors/408.http
            errorfile 500 /etc/haproxy/errors/500.http
            errorfile 502 /etc/haproxy/errors/502.http
            errorfile 503 /etc/haproxy/errors/503.http
            errorfile 504 /etc/haproxy/errors/504.http 
    frontend normal
             bind *:80
             bind *:443 ssl crt </etc/ssl/certs/server.bundle.pem>
             mode http
             option forwardfor
             reqirep ^([^\ :]*)\ /v2(.*$) \1\ /artifactory/api/docker/docker-virtual/v2\2
             reqadd X-Forwarded-Proto:\ https if { ssl_fc }
             option forwardfor header X-Real-IP
             default_backend normal
    
    # if only need to access the docker-dev-local2 then skip this section. Docker-virtual can be configured to deploy to docker-dev-local2 frontend dockerhub
             bind *:5000 ssl crt </etc/ssl/certs/server.bundle.pem>
             mode http
             option forwardfor
             option forwardfor header X-Real-IP
             reqirep ^([^\ :]*)\ /v2(.*$) \1\ /artifactory/api/docker/docker-remote/v2\2
             reqadd X-Forwarded-Proto:\ https if { ssl_fc }
             default_backend normal
    
    # if only need to access the docker-dev-local2 then skip this section. Docker-virtual can be configured to deploy to docker-dev-local2 frontend dockerprod
             bind *:5001 ssl crt </etc/ssl/certs/server.bundle.pem>
             mode http
             option forwardfor
             option forwardfor header X-Real-IP
    	     reqirep ^([^\ :]*)\ /v1(.*$) \1\ /artifactory/api/docker/docker-prod-local/v1\2
    	     reqirep ^([^\ :]*)\ /v2(.*$) \1\ /artifactory/api/docker/docker-prod-local2/v2\2
             reqadd X-Forwarded-Proto:\ https if { ssl_fc }
             default_backend normal
     
    # if only need to access the docker-dev-local2 then skip this section. Docker-virtual can be configured to deploy to docker-dev-local2 frontend dockerdev
             bind *:5002 ssl crt </etc/ssl/certs/server.bundle.pem>
             mode http
             option forwardfor
             option forwardfor header X-Real-IP
    	     reqirep ^([^\ :]*)\ /v1(.*$) \1\ /artifactory/api/docker/docker-dev-local/v1\2
    	     reqirep ^([^\ :]*)\ /v2(.*$) \1\ /artifactory/api/docker/docker-dev-local2/v2\2
             reqadd X-Forwarded-Proto:\ https if { ssl_fc }
             default_backend normal
     
    # Artifactory Non HA Configuration
    # i.e server artifactory 198.168.1.206:8081
    #
    backend normal 
             mode http
             server <artifactory-host> <artifactory-host ip address>:<artifactory-host port>
     
    #
    # Artifactory HA Configuration
    # Using default failover interval - rise = 2; fall =3 3; interval - 2 seconds
    # backend normal
    #        mode http
    #        balance roundrobin
    #        option httpchk OPTIONS /
    #        option forwardfor
    #        option http-server-close
    #        appsession JSESSIONID len 52 timeout 3h
    #        server <artifactory-host-ha1> <artifactory-host ip address>:<artifactory-host port> 
    # 		 server <artifactory-host-ha2> <artifactory-host ip address>:<artifactory-host port>
Anchor
anchorCfgDockerClientPorts
anchorCfgDockerClientPorts
Configuring Your Docker Client 

To configure your Docker client, carry out the following steps 

  1.  Add the following to your DNS or to the client's /etc/hosts file: 

    Code Block
    <ip-address> art.local 
  2. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in the 

    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/#using-self-signed-certificates
    . Alternatively, you can configure the Docker client to work with an insecure registry by adding the following line to your /etc/default/docker file (you may need to create the file if it does not already exist):

    Code Block
    DOCKER_OPTS="$DOCKER_OPTS --insecure-registry art.local:5001"
  3. Restart your Docker engine.

Test Your Setup

To verify your reverse proxy is configured correctly, run the following command:

Code Block
// Make sure the following results in return code 200
curl -I -k -v https://<artifactory url>/api/system/ping

Run the following commands to ensure your proxy configuration is functional and can communicate with Artifactory. In this example, we will pull down a Docker image, tag it and then deploy it to our our docker-virtual repository that is bound to port 5001:

Code Block
// Pull the "hello-world" image
docker pull hello-world
 
// Login to repository docker-virtual
docker login art-local:5001
 
// Tag the "hello-world" image
docker tag hello-world art-local:5001/hello-world
 
// Push the tagged "hello-world" image to docker-virtual
docker push art-local:5001/hello-world
Testing With a Self-signed Certificate
  1. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in the 

    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/#using-self-signed-certificates
    . Alternatively, you can configure the Docker client to work with an insecure registry as described in the 
    Newtablink
    TextDocker documentation
    URLhttps://docs.docker.com/registry/insecure/
    .

  2. Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine). 
    Running $docker info will list the Insecure registries that have been applied under the Insecure Registries entry.

  3. Use the steps above to interact with the Artifactory Docker Registry

Without a Reverse Proxy

Previously, Artifactory supported the Ports and Subdomain methods described above when using a reverse proxy. From version 5.8. Artifactory introduces a new method referred to as the "Repository Path" method since it uses the the Docker repository path prefix (<REPOSITORY_KEY/IMAGE>) to access a specific Artifactory Docker registry from the Docker client. Note that you may still have a reverse proxy configured for Artifactory for other reasons, however when configured to use Repository Path method, requests to Docker registries in Artifactory will be handled by Artifactory's embedded Tomcat instead of the reverse proxy.

Info
titleDocker API v2 required

You can only use the Repository Path method with Artifactory Docker registries configured for Docker API v2. 

Tip
titleSub-domain method is recommended for production
We recommend using the Sub-domain method for Artifactory Docker registries in production
systems since this method is more scalable and enables the use of SSL certificates
systems because this method allows you to add wildcard SSL certificates on the reverse proxy for secure access to the
registries.
While you can add SSL certificates at the Tomcat level, this is not a recommended practice because the process of validation against the certificate is very resource intensive on memory and CPU. 
The Repository Path method
,
is more suitable
for internal testing purposes where
when secure access is not required. 

Configuring Artifactory

To configure Artifactory to use the Repository Path method, carry out the following steps:

  1. Make sure Artifactory is up and running, and is activated with a valid license

  2. Create your virtual Docker repository (as well as a local and remote Docker repository that it should aggregate). In our example below we will use a repository named docker-virtual
  3. Go to the HTTP Settings screen from the Admin module under Configuration | HTTP Settings. 
    In the Docker Settings panel, select Path as the Docker Access Method.
    In the Reverse Proxy Settings panel select Embedded Tomcat as the Server Provider (which indicates you're not using a reverse proxy). 

    Info
    titleYou must use Embedded Tomcat

     You can only use Artifactory as a Docker registry without a reverse proxy by using the internal embedded Tomcat


    Repository Path Method

Configuring Your Docker Client 

Since using the Repository Path method to access Artifactory as a Docker registry without a reverse proxy does not support secure access (i.e. only HTTP is supported, not HTTPS), you need to configure the Docker client to work with an insecure registry as described in the

Newtablink
TextDocker documentation
URLhttps://docs.docker.com/registry/insecure/
.

Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine). Running $docker info will list the Insecure registries that have been applied under the Insecure Registries entry. 

Test Your Setup 

Note
titleDon't use localhost or 127.0.0.1 or "/artifactory"

Due to a limitation in the Docker client, you cannot access an Artifactory Docker registry as localhost or 127.0.0.1. If you need to access a local installation of Artifactory, make sure to specify its full IP address.

In addition, when specifying Artifactory's URL, you should omit the "/artifactory" suffix normally used.

For example, if your local machine's IP address is 10.1.16.114, then you must specify your Artifactory URL as http://10.1.16.114:8081 (using http://localhost:8081 will not work).

The code snippets below assume you have a virtual Docker repository named docker-virtual in an Artifactory installation at IP 10.1.16.114.

First, to verify your Docker client can access Artifactory, run the following command making sure that the return code is 200:

Code Block
curl -I -k -v http://10.1.16.114:8081/artifactory/api/system/ping
  • Login to repository docker-virtual

    Code Block
    docker login -u admin -p password 10.1.16.114:8081
  • Pull the "hello-world" image

    Code Block
    docker pull 10.1.16.114:8081/docker-virtual/hello-world:latest
  • Tag a Docker image

    Code Block
    docker tag 10.1.16.114:8081/docker-virtual/hello-world:latest 10.1.16.114:8081/docker-virtual/<tag_name>
  • Push the tagged image to docker-virtual

    Code Block
    docker push 10.1.16.114:8081/docker-virtual/<tag_name>