Skip to content

index.mdx

Latest commit

 

History

History
91 lines (57 loc) · 3.09 KB

index.mdx

File metadata and controls

91 lines (57 loc) · 3.09 KB
sidebar_label 1. Install Fix Inventory
sidebar_position 1
pagination_label Install Fix Inventory
pagination_prev getting-started/index
pagination_next getting-started/launch/index
unlisted false

Install Fix Inventory

Docker images allow Fix Inventory to be run in a loosely isolated environment called a container.

:::tip

Don't want to manage your own Fix Inventory installation? Get started for free with Fix Security, an all-in-one security dashboard built on top of Fix Inventory.

:::

Prerequisites

  • Docker

  • Docker Compose >= 1.29

  • At least 2 CPU cores and 8 GB of RAM

  • A CPU with AVX support. If running on a VM, set the CPU type to "host" or ensure you expose AVX/AVX2

    :::note

    Fix Inventory performs CPU-intensive graph operations. In a production setup, we recommend at least four cores and 16 gigabytes of RAM. See Configuring Fix Inventory Worker for more information.

    :::

Directions

  1. Fetch the required files from the someengineering/fixinventory GitHub repository:

    $ mkdir -p fixinventory/dockerV2
$ cd fixinventory
$ curl -Lo docker-compose.yaml {{dockerComposeUrl}}
$ curl -Lo dockerV2/prometheus.yml https://raw.githubusercontent.com/someengineering/fixinventory/{{repoBranch}}/dockerV2/prometheus.yml

    :::note

    By default, the fixshell service bind-mounts the ~/fixinventory-downloads directory to /home/fixinventory/downloads in the container. This allows you to access files outputted by Fix Inventory Shell on the host.

    If you would like to change the download location from ~/fixinventory-downloads to another directory, you can do so by editing the docker-compose.yaml file:

    fixshell:
  ...
  volumes:
# highlight-next-line
    - ~/fixinventory-downloads:/home/fixinventory/downloads
  ...

    :::

  2. Start the services defined in the docker-compose.yaml file:

    $ docker-compose pull
$ docker-compose up -d

    Upon execution of docker-compose up -d, Docker Compose will start all components and set up the system. This process takes approximately 1-3 minutes, depending on your machine and internet connection.

    :::note

    Docker Compose V2 integrated compose functions in to the Docker platform.

    In Docker Compose V2, the command is docker compose (no hyphen) instead of docker-compose.

    :::

    :::info

    Fix Inventory publishes packages for both x86 and ARM architectures for stable releases, but edge versions are only available for x86.

    If you have an Apple Silicon or other ARM-based machine, please use the latest stable release ( or latest).

    :::