{"id":20445883,"url":"https://github.com/rapid7/puppet-nexpose","last_synced_at":"2025-04-13T00:44:24.364Z","repository":{"id":66307172,"uuid":"63968657","full_name":"rapid7/puppet-nexpose","owner":"rapid7","description":"Puppet module for Nexpose","archived":false,"fork":false,"pushed_at":"2025-02-25T17:06:06.000Z","size":42,"stargazers_count":5,"open_issues_count":8,"forks_count":12,"subscribers_count":16,"default_branch":"production","last_synced_at":"2025-03-26T18:51:41.769Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rapid7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-07-22T16:43:15.000Z","updated_at":"2025-02-25T17:06:09.000Z","dependencies_parsed_at":"2023-03-13T20:30:02.650Z","dependency_job_id":null,"html_url":"https://github.com/rapid7/puppet-nexpose","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapid7%2Fpuppet-nexpose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapid7%2Fpuppet-nexpose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapid7%2Fpuppet-nexpose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapid7%2Fpuppet-nexpose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rapid7","download_url":"https://codeload.github.com/rapid7/puppet-nexpose/tar.gz/refs/heads/production","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650419,"owners_count":21139672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T10:15:11.428Z","updated_at":"2025-04-13T00:44:24.345Z","avatar_url":"https://github.com/rapid7.png","language":"Puppet","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/rapid7/puppet-nexpose.svg?branch=production)](https://travis-ci.org/rapid7/puppet-nexpose)\n# nexpose\n\n#### Table of Contents\n\n1. [Overview](#overview)\n2. [Installation](#installation)\n3. [Setup - The basics of getting started with nexpose](#setup)\n    * [Beginning with nexpose](#beginning-with-nexpose)\n    * [Dependencies](#dependencies)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n\n## Overview\n\nInstalls and manages your on-prem vulnerability scanner, [Nexpose](https://www.rapid7.com/products/nexpose/)\n\n## Installation\n\n```bash\npuppet module install rapid7-nexpose\n```\n\n## Setup\n\n### Beginning with nexpose\n\nThis will install a Nexpose Engine, ready to be paired with a Nexpose Console. Simple when having to provision multiple engines across your infrastructure.\n\n```puppet\nclass { '::nexpose':\n  component_type     =\u003e 'engine',\n  first_name         =\u003e 'Rapid7',\n  last_name          =\u003e 'User',\n  company_name       =\u003e 'Rapid7 LLC',\n}\n```\n\n### Dependencies\n\n- puppetlabs/stdlib \u003e= 1.0.0\n- puppet-archive \u003e= 0.5.1\n\nSee `metadata.json` for details.\n\n## Usage\n\n### Provision a Nexpose Console\n\n```puppet\nclass { '::nexpose':\n  component_type   =\u003e 'console',\n  first_name       =\u003e 'Rapid7',\n  last_name        =\u003e 'User',\n  company_name     =\u003e 'Rapid7 LLC',\n  nexpose_user     =\u003e 'nxadmin',\n  nexpose_password =\u003e 'super-secret-password',\n}\n```\n\n### Provision a Nexpose Engine using a proxy for updates\n\n```puppet\nclass { '::nexpose':\n  component_type =\u003e 'engine',\n  first_name     =\u003e 'Rapid7',\n  last_name      =\u003e 'User',\n  company_name   =\u003e 'Rapid7 LLC',\n  proxy_uri      =\u003e 'myproxy.example.com:1234',\n}\n```\n\n## Reference\n\n### Classes\n\n#### Public classes\n\n* `nexpose` - Main class, includes all other classes.\n\n#### Private classes\n\n* `nexpose::install` - Installs Nexpose.\n* `nexpose::params` - Defines the default paramaters.\n* `nexpose::service` - Handles the Nexpose service.\n\n### Parameters\n\nThe following parameters are available in the `::nexpose` class:\n\n#### `first_name`\n\nOptional.\n\nData type: String.\n\nDefines the First Name value when installing Nexpose.\n\nDefault value: 'Rapid7'.\n\n#### `last_name`\n\nOptional.\n\nData type: String.\n\nDefines the Last Name value when installing Nexpose.\n\nDefault value: 'User'.\n\n#### `company_name`\n\nOptional.\n\nData type: String.\n\nDefines the Company Name value when installing Nexpose.\n\nDefault value: 'Awesome Company'.\n\n#### `component_type`\n\nOptional.\n\nData type: String.\n\nDefines if Nexpose will be installed as a Console or Engine. Valid values are `engine` or `console` (`typical` is also valid, same as console)\n\nDefault value: 'engine'.\n\n#### `nexpose_user`\n\nOptional.\n\nData type: String.\n\nDefines the username of the Nexpose Administrator account when provisioning a Console type.\n\nDefault value: 'nxadmin'.\n\n#### `nexpose_password`\n\nOptional.\n\nData type: String.\n\nDefines the password of the Nexpose Administrator account when provisioning a Console type.\n\nDefault value: 'nxadmin'.\n\n#### `proxy_uri`\n\nOptional.\n\nData type: String.\n\nDefines the proxy Nexpose will use when pulling software updates.\n\nDefault value: `undef`.\n\n#### `suppress_reboot`\n\nOptional.\n\nData type: Boolean.\n\nBy default, the Nexpose installer reboots the system after installation. This suppresses that action.\n\nDefault value: `true`.\n\n#### `service_enable`\n\nOptional.\n\nData type: Boolean.\n\nDefines if Nexpose should start on system boot.\n\nDefault value: `true`.\n\n#### `service_ensure`\n\nOptional.\n\nData type: String.\n\nIf Nexpose isn't running, Puppet will start it.\n\nDefault value: 'running'.\n\n## Limitations\n\nThis module has only been tested on Ubuntu 14.04 and 16.04.\n\n## Development\n\nComing soon..","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapid7%2Fpuppet-nexpose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapid7%2Fpuppet-nexpose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapid7%2Fpuppet-nexpose/lists"}