AppMap Offline Install for Secure Environments

Assumptions

Access to the following domains for downloading the AppMap application assets manually.

  • https://github.com/
    • For downloading the VS Code or JetBrains extension files
    • For downloading the AppMap application binaries
  • https://getappmap.com
    • To authenticate your VS Code installation
    • NOTE: This is only necessary if you don’t have AppMap provided license keys.

Download Steps

Download the AppMap VS Code Plugin (VSIX)

If you are a JetBrains User, go to the download documentation for the JetBrains plugin.

Navigate to the the AppMap VS Code GitHub latest releases page:

This URL will take you to the most recently released version of the extension.

Alternatively, you can navigate to the main releases page to install any specific version of the extension.

Click on the VSIX file to save the file to your local machine.

Download the AppMap JetBrains Plugin (zip)

Alternatively if you are a JetBrains user, navigate to the AppMap GitHub repository for the JetBrains/IntelliJ plugin latest releases page.

Download the zip file and save locally.

Download the AppMap Application Binaries

Navigate to the AppMap application binaries release page.

Search within the page for a release with the name “@appland/appmap”.

NOTE: You may need to navigate to page 2 depending on the number of released AppMap binaries.

Click on the “Assets” button to expand all the available AppMap binaries.

Download the binary that is specific to your computers’ operating system and architecture. Optionally download the sha256 file as well if you wish to validate the files’ integrity on your local machine.

Download the AppMap Java Jar file

NOTE: The VSIX will be bundled with the latest java jar file from the same release, but this is not guaranteed to be the same as the most recently released version. The steps below will ensure you can download the latest release if your machine is unable to manually update.

To record Java applications, you’ll need to download the AppMap Java Jar file for the code editor extension to use.
Navigate to the AppMap Java releases page for the latest releases of this project.

In the Assets section, download the appmap-<version>.jar file and optionally the .asc file if you would like to validate the file integrity on your local machine.

Installation Steps

Install the AppMap VS Code Plugin (VSIX)

Open VS Code, and then open the Command Palette: Mac: Command + Shift + P Windows: Control + Shift + P

After opening the Command Palette, search for “install from VSIX”

In the following window, locate the VSIX you downloaded previously and select that for installation.

Shift Bullet Points
NOTE: If VS Code is able to connect to the following domains, AppMap binary asset download will complete successfully.
  • objects.githubusercontent.com
  • *.github.com
If access to those URLs is blocked, continue to the “Install Application Binaries” steps below.

Install the AppMap Plugin for JetBrains (zip)

Open your JetBrains editor, and open the “Settings” page.

The settings page should look similar to below.

Search for, or select the “Plugins” option, then select the gear icon and choose “Install Plugin from Disk”

Select the path to the zip file you downloaded in the previous section.

After selecting the AppMap zip file, click “Accept” for the “Third-Party Plugins Notice”

Note: After clicking “Accept” to the JetBrains plugin notice you may need to go back to the previous “Install Plugin from Disk” step and repeat to install the plugin.

When the plugin is successfully installed, you will see it in the settings page plugin list.

If you don’t see it in the list, search for AppMap in the search box to confirm the installation is complete.

After closing the settings page, the AppMap plugin will open.

AppMap collects anonymous usage stats to improve the product, in the pop up on the bottom of the screen, choose to “Opt out” or simply close the popup to keep these anonymous product analytics enabled.

Shift Bullet Points
NOTE: If VS Code is able to connect to the following domains, AppMap binary asset download will complete successfully.
  • objects.githubusercontent.com
  • *.github.com
  • registry.npmjs.org
If access to those URLs is blocked, continue to the “Install Application Binaries” steps below.

Install the AppMap Application Binaries for VS Code

Copy the binary you downloaded in the previous step to the following location.

On Mac and Linux 

$HOME/.appmap/bin/appmap

The file needs to be made executable. You can run the following command.

chmod +x $HOME/.appmap/bin/appmap

On Windows 

%USERPROFILE%\.appmap\bin\appmap.exe

Install the AppMap Application Binaries for JetBrains

Copy the binary you downloaded in the previous step and to the following location.

On Mac 

$HOME/Library/Caches/JetBrains/appland-plugin/appmap/<version>/appmap-macos-arm64

Create the subdirectories if they don’t already exist.

For example:

$HOME/Library/Caches/JetBrains/appland-plugin/appmap/3.164.0/appmap-macos-arm64

The file needs to be made executable. You can run the following command.

chmod +x $HOME/Library/Caches/JetBrains/appland-plugin/appmap/3.164.0/appmap-macos-arm64

On Linux 

$HOME/.cache/JetBrains/appland-plugin/appmap/<version>/appmap-linux-arm64

Create the subdirectories if they don’t already exist.

For example:

$HOME/.cache/JetBrains/appland-plugin/appmap/3.164.0/appmap-linux-arm64

The file needs to be made executable. You can run the following command

chmod +x $HOME/.cache/JetBrains/appland-plugin/appmap/3.164.0/appmap-linux-arm64

On Windows 

%LocalAppData%\JetBrains\appland-plugin\appmap\<version>\appmap-win-x64.exe

Or the fully expanded path on windows.

C:\Users\<YourUsername>\AppData\Local\JetBrains\appland-plugin\appmap\<version>\appmap-win-x64.exe

Create the subdirectories if they don’t already exist.

For Example:

C:\Users\BobSmith\AppData\Local\JetBrains\appland-plugin\appmap\3.164.0\appmap-win-x64.exe

Install the AppMap Java Jar file

Copy the appmap-<version>.jar downloaded in the previous step to the following location. Ensure the file is renamed to appmap.jar

On Mac and Linux

$HOME/.appmap/lib/java/appmap.jar

When recording your Java application, you will pass this file location to the JVM running your application like:

-javaagent:~/.appmap/lib/java/appmap.jar

On Windows

%USERPROFILE%\.appmap\lib\java\appmap.jar

When recording your Java application, you will pass this file location to the JVM running your application like: -javaagent:%USERPROFILE%\.appmap\lib\java\appmap.jar

Confirm Successful Installation

After completing the install steps, you can confirm the installation was done correctly by doing the following:

Open a Navie Chat

Follow the getting started instructions to open a new Navie chat window.
If the AppMap binaries are installed and executable, you should see a new Navie chat window open successfully.

If the binaries are not installed in the correct location, or are not executable, you will show a new Navie window prompt attempting to open but will hang until timeout.

Record a Java Application

To test your Java Jar file is in the right location and working correctly, simply record a java application using the Java command flag.

Refer to the AppMap Agent for Java documentation for more information about using the AppMap Jar for recording Java applications.

$ java -javaagent:$HOME/.appmap/lib/java/appmap.jar -jar target/*.jar
Was this page helpful? thumb_up Yes thumb_down No
Thank you for your feedback!