{"id":21066495,"url":"https://github.com/eidam/easx","last_synced_at":"2026-04-12T18:53:35.127Z","repository":{"id":107401201,"uuid":"291122456","full_name":"eidam/easx","owner":"eidam","description":"OpenResty load balancer using Consul Service Catalog and Redis as a backend for storing provisioned Lets Encrypt certificates.","archived":false,"fork":false,"pushed_at":"2020-12-18T12:24:17.000Z","size":13,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-08T20:07:43.227Z","etag":null,"topics":["consul","docker","hashicorp","lets-encrypt","letsencrypt","nginx","nomad","proxy","resty","ssl"],"latest_commit_sha":null,"homepage":"","language":"Lua","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/eidam.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}},"created_at":"2020-08-28T18:48:33.000Z","updated_at":"2024-09-25T05:56:51.000Z","dependencies_parsed_at":"2023-05-17T10:00:36.833Z","dependency_job_id":null,"html_url":"https://github.com/eidam/easx","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/eidam%2Feasx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eidam%2Feasx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eidam%2Feasx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eidam%2Feasx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eidam","download_url":"https://codeload.github.com/eidam/easx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243510121,"owners_count":20302294,"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":["consul","docker","hashicorp","lets-encrypt","letsencrypt","nginx","nomad","proxy","resty","ssl"],"created_at":"2024-11-19T17:59:56.614Z","updated_at":"2025-12-26T19:05:10.187Z","avatar_url":"https://github.com/eidam.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Easx - easy Nginx with automatic Lets Encrypt \nThis project is heavily inspired by [Ceryx](https://github.com/sourcelair/ceryx), \nrefactored to use [Consul Catalog](https://www.hashicorp.com/blog/consul-and-external-services/) instead of Redis backend for routes. \n\nSSL certificates are stored in redis, but we plan to introduce support for [Vault](https://github.com/hashicorp/vault/)\nand have redis as a caching layer only.\n\n## Prerequisites\n1. Docker\n2. Consul\n3. Redis \n\n## Configuration\n\n### Add service to Consul Catalog\n1. Create `example.json` file\n    ```json\n    {\n      \"Node\": \"easx-domains\",\n      \"Address\": \"easx.domains.dev\",\n      \"NodeMeta\": {\n        \"external-node\": \"true\",\n        \"external-probe\": \"true\"\n      },\n      \"Service\": {\n        \"Service\": \"easx-host.example.com\",\n        \"Tags\": [\n          \"easx.target=https://s3.website.com/and/path\",\n          \"easx.target_host=s3.website.com\"\n        ],\n        \"Port\": 443\n      },\n      \"Checks\": [\n        {\n          \"Name\": \"http-check\",\n          \"status\": \"passing\",\n          \"Definition\": {\n            \"http\": \"https://host.example.com\",\n            \"interval\": \"60s\"\n          }\n        }\n      ]\n    }\n    ```\n\n2. Register the service with Consul \n    ```shell script\n    curl --request PUT --data @example.json localhost:8500/v1/catalog/register\n    ```\n\n### Run the container with `adamjanis/easx` image (or build your own)\n\n#### Environment variables\n`EASX_LETS_ENCRYPT_STAGING` (false) use Lets Encrypt staging\n\n`EASX_LETS_ENCRYPT_HOOK_SERVER_PORT` (8889) hook server port, \nwith Nomad you might wanna use dynamic ports\n\n`EASX_DEBUG` (false) enables DEBUG logs\n\n`EASX_DNS_RESOLVER` (172.17.0.1)\n\n`EASX_REDIS_PREFIX` (easx)\n\n`EASX_REDIS_HOST` (127.0.0.1)\n\n`EASX_REDIS_PASSWORD` ()\n\n`EASX_REDIS_PORT` (6379)\n\n`EASX_REDIS_TIMEOUT` (100ms)\n\n`EASX_REDIS_SSL` (false)\n\n`EASX_REDIS_SSL_VERIFY` (false)\n\n`EASX_CONSUL_SERVICE_PREFIX` (easx-)\n\n`EASX_CONSUL_HOST` (consul.service.consul)\n\n`EASX_CONSUL_PORT` (8500)\n\n`EASX_CONSUL_TOKEN` ()\n\n`EASX_PROXY_DEFAULT_HOST` ($http_host)\n\n\n## Known issues / todo\n- Nginx running with `root` user, auto_ssl could not correctly run on `alpine-fat`\n- Only proxy mode is working right now, with redirect commented out (we dont need it right now)\n- Consul service needs to have both `target` and `target_host` tags set\n- Tests coverage (no tests)\n\n# Build \n-  docker build -t adamjanis/easx:dev ../ \u0026\u0026 docker push adamjanis/easx:dev \u0026\u0026 tf apply","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feidam%2Feasx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feidam%2Feasx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feidam%2Feasx/lists"}