Using the latest version?
JFrog Container Registry Guide
Installation Steps
The installation procedure involves the following main steps:
- Download and extract the package to install (Docker, Helm, Debian or RPM).
- Set up the product configurations (optional) including database, Java Opts, and filestore as described in the Setting Up JFrog Container Registry section.
The system comes with these basic configuration settings:
Default Database: JFrog Container Registry comes with an embedded Derby Database out-of-the-box which it is pre-configured to use, however, for better performance and to reuse existing infrastructures you may have, you can configure JFrog Container Registry to work with alternative supported databases. For details please refer to Configuring the Database.
Default Filestore: By default, JFrog Container Registry is configured to use the local file system as its filestore. JFrog Container Registry supports a variety of additional filestore configurations to meet a variety of needs for binary storage providers, storage size and redundancy. For details, please refer to Configuring the Filestore. - Install the JFrog Container Registry version according to your selected platform:
- Post-Install Steps including changing the default password, as described in the Post-Install section below.
Configuring an HTTP Server (Optional for Docker Registry)
You can run JFrog Container Registry with one of the supported HTTP servers set up as a front end. For details please refer to Configuring a Reverse Proxy.
Post-Installation Steps
Once the installation is complete.
- Change the default admin password.
- Access JFrog Container Registry and run the Onboarding Wizard.
- Continue to configure the system using the Administration Guide.
Configuring an HTTP Server (Optional for Docker Registry)
You can run JFrog Container Registry with one of the supported HTTP servers set up as a front end. For details please refer to Configuring a Reverse Proxy.
Accessing JFrog Container Registry
Once the JFrog Container Registry container is up and running, you access JFrog Container Registry in the usual way by browsing to:
http://SERVER_DOMAIN:8081/artifactory
Default Home Directory
Path Naming Conventions
Please note that the JFrog Container Registry installation and configuration paths and code examples refer to artifactory as JFrog Container Registry runs the core files of JFrog Artifactory.
It is important to know where your ARTIFACTORY_HOME
folder is located, since this folder stores your configurations and important repository data.
When JFrog Container Registry runs for the first time, it sets up a default configuration and creates all necessary files and folders under the ARTIFACTORY_HOME
folder.
The default location of ARTIFACTORY_HOME is {user.home}/.artifactory
.
Permissions on the ARTIFACTORY_HOME Folder
Make sure that the user running the Tomcat has write permissions on the ARTIFACTORY_HOME
folder.
Directory Structure
After installing JFrog Container Registry, the $ARTIFACTORY_HOME
directory will contain the following directory structure (the $ARTIFACTORY_HOME
directory location depends on your installation type):
File/Folder | Description |
---|---|
access | The home directory of the bundled JFrog Access. More details in the Access Tokens page. |
access/etc/keys | JFrog Access keys. More details in the Access Tokens page. |
| JFrog Container Registry log files (general, access, request etc.) |
etc | Configuration files |
etc/plugins | Custom Groovy user plugins. |
etc/security | Global security related files (configuring global encryption key, PGP signing key etc.). |
etc/ui | Manually uploaded custom UI logos. |
| The Derby database (only present when using Derby). |
| The checksum based storage of binaries when using the default filesystem storage. |
| Directory to save temporary files which JFrog Container Registry generates. |
| Directory to save files uploaded using the Web UI. |
bin | JFrog Container Registry startup/shutdown scripts. |
| The default tomcat directory bundled with JFrog Container Registry. |
tomcat/work | The tmp directory tomcat and the JVM uses (Tomcat automatically assigns it to a java system environment variable as java.io.tmpdir) |
tomcat/logs | Additional Tomcat log files |
misc | Configuration files used as examples for different databases and servlet containers. |
| The default backup directory JFrog Container Registry uses for system wide and repository backup. |
webapps | Contains the JFrog Container Registry WAR file and the Access WAR file used by the bundled Tomcat distribution. We strongly recommend keeping both these files in the same bundled Tomcat. |
Default Admin User
Once the installation is complete, JFrog Container Registry has a default user with admin privileges predefined in the system:
User: admin
Password: password
Change the admin password
We strongly recommend changing the admin password as soon as installation is complete.