{"id":24625203,"url":"https://github.com/johnmccabe/lumogon-oldprivate","last_synced_at":"2026-04-12T02:35:52.493Z","repository":{"id":73913162,"uuid":"90071118","full_name":"johnmccabe/lumogon-oldprivate","owner":"johnmccabe","description":"Get a complete picture of what your applications are made of *without* changing how you currently build and run containers. Just run and report.","archived":false,"fork":false,"pushed_at":"2017-05-12T09:59:24.000Z","size":297,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-12T06:13:51.838Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnmccabe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-05-02T19:40:03.000Z","updated_at":"2017-05-12T12:21:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"6589bb4f-af2a-4fb0-9eab-11f76b347bb7","html_url":"https://github.com/johnmccabe/lumogon-oldprivate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/johnmccabe/lumogon-oldprivate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmccabe%2Flumogon-oldprivate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmccabe%2Flumogon-oldprivate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmccabe%2Flumogon-oldprivate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmccabe%2Flumogon-oldprivate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnmccabe","download_url":"https://codeload.github.com/johnmccabe/lumogon-oldprivate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmccabe%2Flumogon-oldprivate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31702580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"online","status_checked_at":"2026-04-12T02:00:06.763Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-01-25T04:13:18.408Z","updated_at":"2026-04-12T02:35:52.477Z","avatar_url":"https://github.com/johnmccabe.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lumogon\n\n[![Build\nStatus](https://travis-ci.com/puppetlabs/lumogon.svg?token=RqtxRv25TsPVz69Qso5L\u0026branch=master)](https://travis-ci.com/puppetlabs/lumogon)\n\n## Introduction\n\nThe Lumogon tool provides a way to inspect the\n[Docker](https://www.docker.com/) containers you have running on your computer.\n`lumogon` can produce a report of what's running, along with the various things\nhappening inside those containers.\n\nTaking this a step further, Lumogon also works with a website hosted on the internet\nwhere you can send reports to view online, and to share with others.\n\n## Trying out Lumogon\n\n### Getting access to the client software\n\nYou'll need [Docker](https://www.docker.com/) installed and running locally.\nThis should already be true if you have Docker containers you want to analyze\nwith Lumogon.\n\nYou can get the Lumogon client via one of two methods:\n\n**Downloading the client from Docker Hub:**\n\n**NOTE: we do not yet have an image on Docker Hub. Until such time you will want to build the client from source. See below.**\n\nThis is the simplest way to get the Lumogon client. At a terminal, do the following:\n\n``` shell\ndocker pull puppetlabs/lumogon\n```\n\n**Building the client from source:**\n\nFor this you'll need a few more things:\n\n - Install [Go](https://golang.org/dl/), version 1.8 or later\n - Set your `$GOPATH` variable to the path where you want to keep your Go sources -- for example, `${HOME}/go`.\n - Download the Lumogon project\n - Build the cli Docker image\n\nNow, at a terminal type:\n\n``` shell\nexport GOPATH=\"${HOME}/go\"\nmkdir -p ${GOPATH}/src/github.com/puppetlabs\ncd ${GOPATH}/src/github.com/puppetlabs\ngit clone https://github.com/puppetlabs/lumogon\ncd $GOPATH/src/github.com/puppetlabs/lumogon\nmake all\n```\n\n### Running the client against your local docker containers\n\nNow that you have the Lumogon client installed, let's run it to find out which\ncontainers you have running and what we can learn about them. The output of the\nclient will be a [JSON](https://en.wikipedia.org/wiki/JSON) listing of all the\ncontainers found and what Lumogon could learn about them.\n\nSince JSON can be hard to read as one big unstructured message, you might want\nto use a \"pretty-printer\" like [jq](https://stedolan.github.io/jq/) to print the\ndata in a more readable format.\n\n``` shell\ndocker run --rm  -v /var/run/docker.sock:/var/run/docker.sock local/lumogon scan | jq .\n```\n\nAfter a few seconds you should see your JSON data:\n\n``` json\n{\n  \"$schema\": \"http://puppet.com/lumogon/core/draft-01/schema#1\",\n  \"generated\": \"2017-04-18 22:30:21.652393839 +0000 UTC\",\n  \"owner\": \"default\",\n  \"group\": [\n    \"default\"\n  ],\n  \"client_version\": {\n    \"BuildVersion\": \"development\",\n    \"BuildTime\": \"2017-04-18 08:50:26 UTC\",\n    \"BuildSHA\": \"7983b886af060dcaba171ebae393e2b31ff57063\"\n  },\n  \"reportid\": \"a862f238-e817-42fc-a972-0563c2cc3992\",\n  \"containers\": {\n    \"fd9a36bbc94cc0503fa87134fb48eb6966f6e70cd663764fc6b201a91dd90d6a\": {\n      \"$schema\": \"http://puppet.com/lumogon/containerreport/draft-01/schema#1\",\n      \"generated\": \"2017-04-18 22:30:20.584745556 +0000 UTC\",\n      \"container_report_id\": \"2a92817d-186f-47e6-9d30-e0df2cdfbf89\",\n      \"container_id\": \"fd9a36bbc94cc0503fa87134fb48eb6966f6e70cd663764fc6b201a91dd90d6a\",\n      \"container_name\": \"/dynamodb\",\n      \"capabilities\": {\n        \"dpkg\": {\n          \"$schema\": \"http://puppet.com/lumogon/capability/label/draft-01/schema#1\",\n          \"title\": \"Dpkg Capability\",\n          \"type\": \"dockerapi\",\n          \"harvestid\": \"09401dde-1b8f-47d7-83b5-ab525f5539eb\",\n          \"payload\": {\n            \"packages\": [\n              \"acl,2.2.52-2\",\n              \"adduser,3.113+nmu3\",\n              \"apt,1.0.9.8.4\",\n              \"base-files,8+deb8u7\",\n              \"base-passwd,3.5.37\",\n              \"bash,4.3-11+deb8u1\",\n              \"bsdutils,1:2.25.2-6\",\n              \"bzip2,1.0.6-7+b3\",\n              \"...skip-a-bit...,0.0.0\",\n              \"zlib1g,1:1.2.8.dfsg-2+b1\"\n            ]\n          }\n        },\n        \"host\": {\n          \"$schema\": \"http://puppet.com/lumogon/capability/host/draft-01/schema#1\",\n          \"title\": \"Host Capability\",\n          \"type\": \"attached\",\n          \"harvestid\": \"226fba7a-a913-45f9-8f46-d57d719d30a5\",\n          \"payload\": {\n            \"BootTime\": 1492180953,\n            \"HostID\": \"a2cbff83-c8ad-e238-b8f4-59665c5c1e34\",\n            \"Hostname\": \"e740aad631fb\",\n            \"KernelVersion\": \"4.9.13-moby\",\n            \"OS\": \"linux\",\n            \"Platform\": \"debian\",\n            \"PlatformFamily\": \"debian\",\n            \"PlatformVersion\": \"8.7\",\n            \"Procs\": 61,\n            \"Uptime\": 373667,\n            \"VirtualizationRole\": \"guest\",\n            \"VirtualizationSystem\": \"docker\"\n          }\n        },\n        \"label\": {\n          \"$schema\": \"http://puppet.com/lumogon/capability/label/draft-01/schema#1\",\n          \"title\": \"Label Capability\",\n          \"type\": \"dockerapi\",\n          \"harvestid\": \"dc50f42f-f459-4100-8c09-db3a1ef88335\",\n          \"payload\": {\n            \"default\": \"No labels found\"\n          }\n        }\n      }\n    }\n  }\n}\n```\n\nSince this output is valid JSON, you can slice and dice it with `jq`, or pass it\nalong to any other tool you use that can accept JSON input.\n\n### Sending container reports to the reporting website\n\nIf you provide a `--endpoint` argument with a URL to the lumogon program,\nit will send your JSON data to our reporting application where you can share the\nreports via a URL.\n\nTry this:\n\n``` shell\ndocker run --rm -v /var/run/docker.sock:/var/run/docker.sock local/lumogon report --endpoint https://consumer.api.lumogon.com/api/v1/\n```\n\nIf all goes as planned, you should see a line like the following with a URL you can visit to view your results:\n\n```\nhttp://reporter.api.lumogon.com/aHrhCcXT2sJBrrewEFCGaWEYbJnqV0vQWMwzO3Dzhbc=\n```\n\n### More ways to use the Lumogon client\n\nLet's get the usage for the Lumogon client:\n\n``` shell\ndocker run --rm  -v /var/run/docker.sock:/var/run/docker.sock local/lumogon --help\nCreates and attaches a container to the target, which harvests data from the target and sends to the Lumogon service\n\nUsage:\n  lumogon [command]\n\nAvailable Commands:\n  help        Help about any command\n  report      Scan one or more containers and send the collected information to the Lumogon service\n  scan        Scan one or more containers and print the collected information\n  version     Lumogon client version\n\nFlags:\n      --config string     config file (default is $HOME/.cli.yaml)\n  -d, --debug             Print debug logging\n  -k, --keep-harvesters   Keeps harvester containers instead of automatically deleting\n```\n\nFeel free to explore those command-line options.  Of note:\n\n - The \"--keep-harvesters\" flag will preserve containers that are created on the fly to explore your other containers. You can use `docker logs \u003ccontainerid\u003e\" to see more of what they found while running.\n - You can specify `scan` to collect data on all your running containers, or you can specify a specific container by passing `scan \u003ccontainerid\u003e`.\n - `-d` will generate more verbose debugging output so you can see Lumogon exploring your containers.\n\n### Giving us feedback\n\nWe'd love to hear from you. Feel free to contact us via email at (**TODO: set up the contact email address**). We also\nrun a [Slack](https://slack.com/) channel at (**TODO: Set up the Slack channel**). And, if you're a developer\nand want to know more about how all this works, check out the next section.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmccabe%2Flumogon-oldprivate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnmccabe%2Flumogon-oldprivate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmccabe%2Flumogon-oldprivate/lists"}