{"id":13670052,"url":"https://github.com/Norwik/Helmet","last_synced_at":"2025-04-27T09:31:35.526Z","repository":{"id":37758902,"uuid":"387282473","full_name":"Norwik/Helmet","owner":"Norwik","description":"🐺 A Lightweight Cloud Native API Gateway.","archived":false,"fork":false,"pushed_at":"2024-11-09T15:47:40.000Z","size":11433,"stargazers_count":131,"open_issues_count":4,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-09T16:34:14.970Z","etag":null,"topics":["api-authentication","api-authorizarion","api-gateway","basic-authentication","clivern","cloud-native","golang","helmet","microservices","oauth2"],"latest_commit_sha":null,"homepage":"https://norwik.github.io/Helmet/","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/Norwik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"custom":"buymeacoffee.com/clivern"}},"created_at":"2021-07-18T22:40:53.000Z","updated_at":"2024-09-11T09:59:06.000Z","dependencies_parsed_at":"2024-06-10T19:06:42.667Z","dependency_job_id":"c2816826-6a6f-4667-b825-f61955af19b1","html_url":"https://github.com/Norwik/Helmet","commit_stats":null,"previous_names":["spacewalkio/helmet","norwik/helmet","clevenio/helmet","clivern/drifter"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Norwik%2FHelmet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Norwik%2FHelmet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Norwik%2FHelmet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Norwik%2FHelmet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Norwik","download_url":"https://codeload.github.com/Norwik/Helmet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224067008,"owners_count":17250097,"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":["api-authentication","api-authorizarion","api-gateway","basic-authentication","clivern","cloud-native","golang","helmet","microservices","oauth2"],"created_at":"2024-08-02T09:00:30.835Z","updated_at":"2024-11-11T07:31:06.691Z","avatar_url":"https://github.com/Norwik.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Norwik/Helmet/main/assets/logo.png?v=1.0.27\" width=\"200\" /\u003e\n    \u003ch3 align=\"center\"\u003eHelmet\u003c/h3\u003e\n    \u003cp align=\"center\"\u003eA Lightweight Cloud Native API Gateway.\u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://github.com/norwik/Helmet/actions/workflows/build.yml\"\u003e\n            \u003cimg src=\"https://github.com/norwik/Helmet/actions/workflows/build.yml/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/norwik/Helmet/actions\"\u003e\n            \u003cimg src=\"https://github.com/norwik/Helmet/workflows/Release/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/norwik/Helmet/releases\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/Version-1.0.27-9B59B6.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://goreportcard.com/report/github.com/norwik/Helmet\"\u003e\n            \u003cimg src=\"https://goreportcard.com/badge/github.com/norwik/Helmet?v=1.0.27\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://godoc.org/github.com/norwik/helmet\"\u003e\n            \u003cimg src=\"https://godoc.org/github.com/norwik/helmet?status.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/norwik/Helmet/blob/master/LICENSE\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/LICENSE-MIT-E74C3C.svg\"\u003e\n        \u003c/a\u003e\n    \u003c/p\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Norwik/Helmet/main/assets/chart.jpg?v=1.0.27\" width=\"80%\" /\u003e\n\u003c/p\u003e\n\nHelmet is Cloud Native API Gateway that control who accesses your API whether from customer or other internal services. It also collect metrics about service calls count, latency, success rate and much more!\n\nHere is some of the key features:\n\n- Manage Service to Service Authentication, Authorization and Communication.\n- Manage End User to Service Authentication, Authorization and Communication.\n- Basic, API Key Based and OAuth2 Authentication Support.\n- Multiple Backends Support with Load Balancing, Health Checks.\n- Runtime Metrics for both Helmet and Backend Services exposed for Prometheus.\n- CORS Support.\n- HTTP/2 support.\n- Rate Limiting Support.\n- Circuit Breaker Support.\n- Caching Layer to make it even more faster.\n- Lightweight, Easy to Deploy and Operate.\n\n\n## Documentation\n\n#### Linux Deployment\n\nDownload [the latest helmet binary](https://github.com/norwik/Helmet/releases). Make it executable from everywhere.\n\n```zsh\n$ export LATEST_VERSION=$(curl --silent \"https://api.github.com/repos/norwik/Helmet/releases/latest\" | jq '.tag_name' | sed -E 's/.*\"([^\"]+)\".*/\\1/' | tr -d v)\n\n$ curl -sL https://github.com/norwik/Helmet/releases/download/v{$LATEST_VERSION}/helmet_{$LATEST_VERSION}_Linux_x86_64.tar.gz | tar xz\n```\n\nThen install `MySQL` and `Redis` on the server or a separate one.\n\nCreate the configs file `config.yml` from `config.dist.yml`. Something like the following:\n\n```yaml\n# App configs\napp:\n    # App name\n    name: ${HELMET_APP_NAME:-helmet}\n    # Env mode (dev or prod)\n    mode: ${HELMET_APP_MODE:-dev}\n    # HTTP port\n    port: ${HELMET_API_PORT:-8000}\n    # Hostname\n    hostname: ${HELMET_API_HOSTNAME:-127.0.0.1}\n    # TLS configs\n    tls:\n        status: ${HELMET_API_TLS_STATUS:-off}\n        crt_path: ${HELMET_API_TLS_PEMPATH:-cert/server.crt}\n        key_path: ${HELMET_API_TLS_KEYPATH:-cert/server.key}\n\n    # Global timeout\n    timeout: ${HELMET_API_TIMEOUT:-50}\n\n    # API Configs\n    api:\n        key: ${HELMET_API_KEY:-6c68b836-6f8e-465e-b59f-89c1db53afca}\n\n    # CORS status\n    cors:\n        status: ${HELMET_CORS_STATUS:-off}\n\n    # Application Database\n    database:\n        # Database driver (sqlite3, mysql)\n        driver: ${HELMET_DATABASE_DRIVER:-sqlite3}\n        # Database Host\n        host: ${HELMET_DATABASE_MYSQL_HOST:-localhost}\n        # Database Port\n        port: ${HELMET_DATABASE_MYSQL_PORT:-3306}\n        # Database Name\n        name: ${HELMET_DATABASE_MYSQL_DATABASE:-helmet.db}\n        # Database Username\n        username: ${HELMET_DATABASE_MYSQL_USERNAME:-root}\n        # Database Password\n        password: ${HELMET_DATABASE_MYSQL_PASSWORD:-root}\n\n    # Key Store Configs\n    key_store:\n        # Cache Driver\n        driver: ${HELMET_CACHE_DRIVER:-redis}\n        # Redis Driver Configs\n        redis:\n            # Redis Address\n            address: ${HELMET_CACHE_REDIS_ADDR:-localhost:6379}\n            # Redis Password\n            password: ${HELMET_CACHE_REDIS_PASSWORD:-}\n            # Redis Database\n            database: ${HELMET_CACHE_REDIS_DB:-0}\n\n    # Endpoint Configs\n    endpoint:\n        # Orders Internal Service\n        - name: orders_service\n          active: true\n          proxy:\n            listen_path: \"/orders/v2/*\"\n            upstreams:\n                balancing: roundrobin\n                targets:\n                    - target: https://httpbin.org/anything/orders1/v2\n                    - target: https://httpbin.org/anything/orders2/v2\n                    - target: https://httpbin.org/anything/orders3/v2\n                    - target: https://httpbin.org/anything/orders4/v2\n            http_methods:\n                - ANY\n            authentication:\n                status: on\n            # Rate limit use the key store for fast read write\n            rate_limit:\n                status: off\n            # Circuit Breaker use the key store for fast read write\n            circuit_breaker:\n                status: off\n\n        # Customers Internal Service\n        - name: customers_service\n          active: true\n          proxy:\n            listen_path: \"/customer/v2/*\"\n            upstreams:\n                balancing: random\n                targets:\n                    - target: https://httpbin.org/anything/customers1/v2\n                    - target: https://httpbin.org/anything/customers2/v2\n                    - target: https://httpbin.org/anything/customers3/v2\n                    - target: https://httpbin.org/anything/customers4/v2\n            http_methods:\n                - GET\n                - POST\n                - PUT\n                - DELETE\n            authentication:\n                status: on\n            # Rate limit use the key store for fast read write\n            rate_limit:\n                status: off\n            # Circuit Breaker use the key store for fast read write\n            circuit_breaker:\n                status: off\n\n    # Log configs\n    log:\n        # Log level, it can be debug, info, warn, error, panic, fatal\n        level: ${HELMET_LOG_LEVEL:-info}\n        # Output can be stdout or abs path to log file /var/logs/helmet.log\n        output: ${HELMET_LOG_OUTPUT:-stdout}\n        # Format can be json\n        format: ${HELMET_LOG_FORMAT:-json}\n```\n\nThe run the `helmet` with `systemd`\n\n```zsh\n$ helmet server -c /path/to/config.yml\n```\n\n\n## Versioning\n\nFor transparency into our release cycle and in striving to maintain backward compatibility, Helmet is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.\n\nSee the [Releases section of our GitHub project](https://github.com/norwik/helmet/releases) for changelogs for each release version of Helmet. It contains summaries of the most noteworthy changes made in each release.\n\n\n## Bug tracker\n\nIf you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/norwik/helmet/issues\n\n\n## Security Issues\n\nIf you discover a security vulnerability within Helmet, please send an email to [hello@clivern.com](mailto:hello@clivern.com)\n\n\n## Contributing\n\nWe are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.\n\n\n## License\n\n© 2021, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).\n\n**Helmet** is authored and maintained by [@Clivern](http://github.com/Clivern).\n","funding_links":["buymeacoffee.com/clivern"],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNorwik%2FHelmet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNorwik%2FHelmet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNorwik%2FHelmet/lists"}