Skip to main content

Installation

Download the latest Lynx agent binary for Linux or macOS below. Windows support will come shortly.

Linux

OSArchitectureDownload Command
Ubuntux64 (Intel/AMD)wget https://lynx-agent.s3.us-west-2.amazonaws.com/0.0.3/ubuntu/ubuntu_x64_lynx.bin -O lynx_agent
Ubuntuarm64 (ARM)wget https://lynx-agent.s3.us-west-2.amazonaws.com/0.0.3/ubuntu/ubuntu_arm64_lynx.bin -O lynx_agent

Usage

Authentication

  1. Run command
chmod +x ./lynx_agent
./lynx_agent configure
  1. Generate credential key pair on web by clicking Generate credential key pair under User Settings.
  2. Enter LYNX_SECRET_ACCESS_ID and LYNX_SECRET_ACCESS_KEY when prompted.

Running Lynx Agent

Run the downloaded program ./lynx_agent before starting any investigation. We recommend starting Lynx agent in a screen or tmux shell so you do not have to run Lynx every time you start any investigation.

Lynx Config

When you first connect Lynx to your environment, Lynx will automatically generate a config file at ~/.lynx/config with details about your environment, including OS name and version, CLI tools, and more. You can edit this config file directly on your machine to further customize your Lynx experience. Custom values you specify in this config will not be sent to the Lynx server. We recommend using the Lynx config file to specify an absolute path to your codebase and sensitive credentials to access your infrastructure. Example config:
## Lynx Generated Keys
## Do not edit
os_name=Ubuntu
os_version=22.04.5 LTS (Jammy Jellyfish)
aws_cli_version=aws-cli/2.22.12

## User Generated Keys
## Add values here
codebase_dir=/home/ubuntu/myapp
I