Skip to content

ParetoSecurity/agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


ParetoSecurity

OpenSSF Scorecard Downloads OpenSSF Scorecard Integration Tests Unit Tests Release

Automatically audit your device for basic security hygiene.

Installation

Using Debian/Ubuntu/Pop!_OS/RHEL/Fedora/CentOS

See https://pkg.paretosecurity.com for install steps.

Quick Start

To run a one-time security audit:

paretosecurity check

Using Nix

Install from nixpkgs

Install CLI from nixpkgs

$ nix-env -iA nixpkgs.paretosecurity

or

$ nix profile install nixpkgs#paretosecurity

Install on NixOS

Install NixOS module

Add this to your NixOS configuration:

{
  services.paretosecurity.enable = true;
}

This will install the agent and its root helper so you don't need sudo to run it.

Install CLI only in NixOS via nixpkgs

Add this to your NixOS configuration:

{ pkgs, ... }: {
  environment.systemPackages = [ pkgs.paretosecurity ];
}

Run checks

$ paretosecurity check

This will analyze your system and provide a security report highlighting potential improvements and vulnerabilities.

If you did not install the root helper, you need to run it with sudo:

$ sudo paretosecurity check

Install via nix-channel

As root run:

$ sudo nix-channel --add https://github.com/ParetoSecurity/agent/archive/main.tar.gz paretosecurity
$ sudo nix-channel --update

Install CLI via nix-channel

To install the paretosecurity binary:

{
  environment.systemPackages = [ (pkgs.callPackage <paretosecurity/pkgs/paretosecurity.nix> {}) ];
}

Run checks

paretosecurity check

This will analyze your system and provide a security report highlighting potential improvements and vulnerabilities.

Install via Flakes

Install CLI via Flakes

Using NixOS module (replace system "x86_64-linux" with your system):

{
  environment.systemPackages = [ paretosecurity.packages.x86_64-linux.default ];
}

e.g. inside your flake.nix file:

{
  inputs.paretosecurity.url = "github:paretosecurity/agent";
  # ...

  outputs = { self, nixpkgs, paretosecurity }: {
    # change `yourhostname` to your actual hostname
    nixosConfigurations.yourhostname = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        # ...
        {
          environment.systemPackages = [ paretosecurity.packages.${system}.default ];
        }
      ];
    };
  };
}

Run checks

paretosecurity check

This will analyze your system and provide a security report highlighting potential improvements and vulnerabilities.

About

Automatically audit your Mac/Linux/Windows machine for basic security hygiene.

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 11