{"id":34151830,"url":"https://github.com/kare/vanity","last_synced_at":"2026-03-10T20:02:02.651Z","repository":{"id":46268661,"uuid":"71442175","full_name":"kare/vanity","owner":"kare","description":"Go vanity domain HTTP handler","archived":false,"fork":false,"pushed_at":"2025-07-28T15:40:13.000Z","size":144,"stargazers_count":31,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-14T21:36:53.343Z","etag":null,"topics":["go","godoc","golang","redirects","vanity","vcs"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kare.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":"2016-10-20T08:37:28.000Z","updated_at":"2025-08-01T14:19:07.000Z","dependencies_parsed_at":"2023-10-01T14:59:07.367Z","dependency_job_id":"7b8f04d0-515e-433a-9295-d3896dcecfb2","html_url":"https://github.com/kare/vanity","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/kare/vanity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kare%2Fvanity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kare%2Fvanity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kare%2Fvanity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kare%2Fvanity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kare","download_url":"https://codeload.github.com/kare/vanity/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kare%2Fvanity/sbom","scorecard":{"id":550168,"data":{"date":"2025-08-11","repo":{"name":"github.com/kare/vanity","commit":"bd9978eea5d6636ca7a1be3092690397aeba9f24"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.7,"checks":[{"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":"Maintained","score":10,"reason":"17 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","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":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/triage.yaml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/ci.yaml:4","Info: topLevel 'contents' permission set to 'read': .github/workflows/release-created.yaml:4","Warn: no topLevel permission defined: .github/workflows/triage.yaml:1","Info: no jobLevel write permissions found"],"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":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":0,"reason":"Found 0/20 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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kare/vanity/ci.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-created.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/kare/vanity/release-created.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/triage.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/kare/vanity/triage.yaml/main?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"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":"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":"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: BSD 3-Clause \"New\" or \"Revised\" 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":"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"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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":"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":"SAST","score":8,"reason":"SAST tool is not run on all commits -- score normalized to 8","details":["Warn: 14 commits out of 16 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"}}]},"last_synced_at":"2025-08-20T10:36:03.095Z","repository_id":46268661,"created_at":"2025-08-20T10:36:03.095Z","updated_at":"2025-08-20T10:36:03.095Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30351735,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T15:55:29.454Z","status":"ssl_error","status_checked_at":"2026-03-10T15:54:58.440Z","response_time":106,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["go","godoc","golang","redirects","vanity","vcs"],"created_at":"2025-12-15T05:43:00.352Z","updated_at":"2026-03-10T20:02:02.639Z","avatar_url":"https://github.com/kare.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kkn.fi/vanity\n[![CI](https://github.com/kare/vanity/workflows/CI/badge.svg)](https://github.com/kare/vanity/actions?query=workflow%3ACI)\n[![Go Reference](https://pkg.go.dev/badge/kkn.fi/vanity.svg)](https://pkg.go.dev/kkn.fi/vanity)\n[![GoReportCard](https://goreportcard.com/badge/kkn.fi/vanity)](https://goreportcard.com/report/kkn.fi/vanity)\n    \n## Concepts\n- VCS is Version Control System (such as `git` or `hg`)\n\t- Repo root is the root path the source code repository (such as \"https://github.com/kare\")\n- Domain is the internet address where the Go Vanity server is hosted (such as\n  9fans.net or kkn.fi). Domain is deduced from HTTP request or can be set as a\n  parameter.\n- Path is the path component of the Go package (such as `/cmd/tcpproxy` in `kkn.fi/cmd/tcpproxy`)\n\n## Specification\n- [Go 1.4 Custom Import Path Checking](https://docs.google.com/document/d/1jVFkZTcYbNLaTxXD9OcGfn7vYv5hWtPx9--lTx1gPMs/edit)\n\n## Features\n- Zero dependencies.\n- Redirects Go tool to VCS.\n- Redirects browsers to [pkg.go.dev](https://pkg.go.dev) module server by default. Module Server URL is configurable.\n- Automatic configuration of cmd packages:\n\t- All packages are redirected without sub-packages to VCS root.\n\t- Packages whose path is prefixed with `/cmd/` redirect automatically to VCS root by stripping the `/cmd` prefix from the package path.\n\t- Examples:\n\t\t- Redirect request `kkn.fi/cmd/tcpproxy` to `github.com/kare/tcpproxy`\n\t\t- Redirect request `kkn.fi/project/sub/package` to `github.com/kare/project`\n\n## Vanity configurable options\nVanity package supports configurable [Option](https://pkg.go.dev/kkn.fi/vanity#Option)s via the [constructor](https://pkg.go.dev/kkn.fi/vanity#NewHandlerWithOptions). Use Option types to configure vanity handler features. Basic Options are documented below:\n- Set [Version Control](https://pkg.go.dev/kkn.fi/vanity/#VCS) System type.\n- Configurable [Version Control System HTTP URL](https://pkg.go.dev/kkn.fi/vanity/#VCSURL)\n- [Module server URL](https://pkg.go.dev/kkn.fi/vanity/#ModuleServerURL) options are:\n\t- https://pkg.go.dev/\n\t- https://github.com/YOUR_USERNAME/\n- Vanity server domain name defaults to request hostname, but it can also be configured.\n- [Configurable](https://pkg.go.dev/kkn.fi/vanity/#Log) [Logger](https://pkg.go.dev/kkn.fi/vanity/#Logger) which is\n  compatible with the standard [log.Logger](https://pkg.go.dev/log#Logger). Default output goes to standard error.\n- Configurable [static content directory](https://pkg.go.dev/vanity/#StaticDir) for images, CSS, and etc.\n- Configurable [IndexPageHandler](https://pkg.go.dev/vanity/#IndexPageHandler). Defaults to index.html file in the static content directory root.\n- Configurable [robots.txt](https://pkg.go.dev/vanity/#RobotsTxt) [file](https://www.robotstxt.org).\n\n## Installation\n```\ngo get kkn.fi/vanity\n```\n\n## Development\nNew features or bug fixes must include comprehensive unit tests.\n\n### Bugs\n- Search [GitHub Issues](https://github.com/kare/kkn.fi-srv/issues) for existing bugs or open a new issue to report a new bug.\n- To fix an existing bug from GitHub Issues open a new [GitHub Pull Request](https://github.com/kare/kkn.fi-srv/pulls).\n\n### Building new features\n1. Open a new [GitHub Issue](https://github.com/kare/kkn.fi-srv/issues) to discuss or propose a new feature.\n1. Open a new Pull Request for a new feature that has beed already discussed.\n\n### Execute compiler, tests and tools\nUse [`Makefile`](https://github.com/kare/kkn.fi-srv/blob/main/Makefile) to execute Go compiler, tests and tools.\n\nRun all tests\n```bash\nmake test\n```\nExecute short (unit) running tests\n```bash\nmake test-unit\n```\nExecute long (integration) running tests\n```bash\nmake test-integration\n```\nRun `goimports`\n```bash\nmake goimports\n```\nRun `staticcheck`\n```bash\nmake staticcheck\n```\nRun gofmt with simplify\n```bash\nmake fmt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkare%2Fvanity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkare%2Fvanity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkare%2Fvanity/lists"}