{"id":13808984,"url":"https://github.com/trazfr/freebox-exporter","last_synced_at":"2026-03-02T06:03:08.926Z","repository":{"id":53846193,"uuid":"147439778","full_name":"trazfr/freebox-exporter","owner":"trazfr","description":"Prometheus exporter for the Freebox","archived":false,"fork":false,"pushed_at":"2025-04-22T19:26:24.000Z","size":106,"stargazers_count":22,"open_issues_count":4,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-02T08:27:23.243Z","etag":null,"topics":["freebox","prometheus","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trazfr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2018-09-05T01:06:50.000Z","updated_at":"2025-04-22T19:25:27.000Z","dependencies_parsed_at":"2024-05-11T13:28:09.235Z","dependency_job_id":"7e99aa26-950c-45c5-b2fc-b137a3b2cfb4","html_url":"https://github.com/trazfr/freebox-exporter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/trazfr/freebox-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trazfr%2Ffreebox-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trazfr%2Ffreebox-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trazfr%2Ffreebox-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trazfr%2Ffreebox-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trazfr","download_url":"https://codeload.github.com/trazfr/freebox-exporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trazfr%2Ffreebox-exporter/sbom","scorecard":{"id":897544,"data":{"date":"2025-08-11","repo":{"name":"github.com/trazfr/freebox-exporter","commit":"59b286ca887d57ec6edbf42cc4ba6593137cba20"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T14:18:50.084Z","repository_id":53846193,"created_at":"2025-08-24T14:18:50.084Z","updated_at":"2025-08-24T14:18:50.084Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29993544,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T01:47:34.672Z","status":"online","status_checked_at":"2026-03-02T02:00:07.342Z","response_time":60,"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":["freebox","prometheus","prometheus-exporter"],"created_at":"2024-08-04T01:01:57.005Z","updated_at":"2026-03-02T06:03:08.889Z","avatar_url":"https://github.com/trazfr.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# freebox-exporter\n\nPrometheus exporter for the [Freebox](https://www.free.fr/freebox/)\n\n**Disclaimer**: I am not related to Iliad, Free or any of their subsidiaries. I have only created this Prometheus exporter to monitor my own device using some [publicly available documentation](https://dev.freebox.fr/sdk/os/).\n\n## Install\n\n### Since Golang 1.16\n\nHaving a working Golang \u003e= 1.16 environment using Go modules:\n\n```bash\ngo install github.com/trazfr/freebox-exporter@latest\n```\n\n### Older Golang\n\nThis package requires at least Golang 1.13. For Golang 1.13:\n\n```bash\nGO111MODULE=on go get github.com/trazfr/freebox-exporter@latest\nGO111MODULE=on go install github.com/trazfr/freebox-exporter\n```\n\n## Use\n\nThis program is to be run in 2 steps, as you must authorize the exporter to access the Freebox. Once authorized, it may be run from anywhere.\n\n```\nUsage: freebox-exporter [options] \u003capi_token_file\u003e\n\napi_token_file: file to store the token for the API\n\noptions:\n  -debug\n        enable the debug mode\n  -hostDetails\n        get details about the hosts connected to wifi and ethernet. This increases the number of metrics\n  -httpDiscovery\n        use http://mafreebox.freebox.fr/api_version to discover the Freebox at the first run (by default: use mDNS)\n  -listen string\n        listen to address (default \":9091\")\n```\n\n### Step 1 authorize API\n\nFrom the Freebox network, generate a token file for the API. The file `token.json` must not exist:\n\n```bash\n$ freebox-exporter token.json\nCould not find the configuration file token.json\nFreebox discovery: mDNS\n1 Please accept the login on the Freebox Server\n...\n```\n\nYou must accept the API on the Freebox device.\n\nOnce done, the credentials will be stored in the new file `token.json`\n\n**In case of errors**:\n\nIf you get the message `panic: Access is timeout`, you have to be faster to accept the access on the Freebox.\n\nIf you get the message `panic: MDNS timeout`, there may be a firewall preventing you to use mDNS. You may try to get the token using HTTP:\n\n```bash\n$ freebox-exporter -httpDiscovery token.json\nCould not find the configuration file token.json\nFreebox discovery: GET http://mafreebox.freebox.fr/api_version\n1 Please accept the login on the Freebox Server\n...\n```\n\n### Step 2 run\n\nOnce you have generated the token you may run from anywhere.\n\n```bash\n$ freebox-exporter token.json\nUse configuration file token.json\nListen to :9091\n```\n\nThen you may test it:\n\n```bash\n$ curl 127.0.0.1:9091/metrics\n# HELP freebox_connection_bandwith_bps available upload/download bandwidth in bit/s\n# TYPE freebox_connection_bandwith_bps gauge\n...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrazfr%2Ffreebox-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrazfr%2Ffreebox-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrazfr%2Ffreebox-exporter/lists"}