Using the latest version?
JFrog Platform User Guide
JFrog Artifactory 6.x Documentation
To get the latest version, go to the JFrog Unified Platform
Requirements
Setting JAVA_HOME
As mentioned in the section on System Requirements, make sure that your JAVA_HOME
environment variable is correctly set to your JDK installation.
Troubleshooting
Note that normally the installation path to your JAVA_HOME might include a space, e.g. c:\Program Files (x86)\java\jdk, this might cause an issue and result in error "Files was unexpected at this time", in which case you will need to replace the Program Files (x86) with PROGRA~2 and make sure there are no spaces in the path.
Setting Java Memory Parameters
While not a strict requirement, it is recommended to modify the JVM memory parameters used to run Artifactory.
This is done by modifying the JAVA_OPTIONS
variable in artifactory.bat
, for a manual installation, or the JOPTS
variable in installService.bat
when running Artifactory as a service.
For your changes to take effect you need to stop Artifactory and then rerun the modified file.
If you can reserve at least 512MB for Artifactory, the recommended values for JVM parameters are as follows:
Recommended JVM parameter settings
The larger your repository or number of concurrent users, the larger you need to make the -Xms and -Xmx values accordingly.
Recommended values are:
-server -Xms512m -Xmx4g -Xss256k -XX:+UseG1GC
Manual Installation
Browse to %ARTIFACTORY_HOME%\bin
and execute the file artifactory.bat
. This script searches for the Java executable and runs Artifactory's main class.
Security settings
Depending on the security settings under Windows, you might need to run artifactory.bat
using 'Run as administrator'
Don't forget to modify your JVM parameters as needed by setting JAVA_OPTIONS in $ARTIFACTORY_HOME/bin/artifactory.bat
.
To test your installation see Accessing Artifactory.
Service Installation
Artifactory makes use of the Apache Commons Procrun components allowing you to install the application as a Windows Service.
To run Artifactory as a Windows service, browse to %ARTIFACTORY_HOME%\bin, and execute the file
InstallService.bat
.
By editing InstallService.bat,
you can modify default properties such as JOPTS
and the log directory.
For your changes to take effect you need to stop the currently running Artifactory service and run InstallService.bat
again once you have completed your modifications.
To test your installation see Accessing Artifactory.
Security
Windows 8 implements strict User Account Control (UAC). You must either disable UAC or right-click on cmd.exe
and select "Run as administrator" in order to run this script.
Running on 32 bit Windows
If you are running a 32 bit version of Windows you need to do the following:
- Download the latest version of the Apache Commons Daemon.
- Take
prunsvr.exe
from the downloaded archive and rename it toartifactory-service.exe
- Replace the current
artifactory-service.exe
found in your %ARTIFACTORY_HOME%/bin
directory
Don't forget to modify your JVM parametersas needed by setting JAVA_OPTIONS in $ARTIFACTORY_HOME/etc/default.
You need to reinstall the service for your changes to take effect.
Running Artifactory
After installing Artifactory you need to start the service.
To start or stop Artifactory as a service you can use the following command in a Command Prompt window:
sc start|stop Artifactory
Checking the status of the Artifactory service
Once Artifactory is correctly installed, you can check if it is running with:
sc query Artifactory
You can also use any standard text editor to view the artifactory log data found in $ARTIFACTORY_HOME/logs/artifactory.log
Running with Docker
From Version 3.6, Artifactory may be pulled as a Docker Image. To run Artifactory in a Docker container on a Windows system, please refer to Installing with Docker.
Accessing Artifactory
Artifactory can be accessed using the following URL:
http://SERVER_DOMAIN:8081/artifactory
.
For example, if you are testing on your local machine you would use: http://localhost:8081/artifactory