{"id":29723416,"url":"https://github.com/laurynasgadl/lockronomicon","last_synced_at":"2025-07-24T18:33:51.420Z","repository":{"id":99040052,"uuid":"371925850","full_name":"laurynasgadl/lockronomicon","owner":"laurynasgadl","description":"🔏 Lockronomicon is a simple lock service for distributed systems. It provides a slim HTTP API to a FS-based locking mechanism.","archived":false,"fork":false,"pushed_at":"2021-05-29T10:40:10.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-21T03:25:10.476Z","etag":null,"topics":["golang","locking"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/laurynasgadl.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":"2021-05-29T08:57:02.000Z","updated_at":"2021-05-29T10:42:00.000Z","dependencies_parsed_at":"2023-03-17T11:15:34.818Z","dependency_job_id":null,"html_url":"https://github.com/laurynasgadl/lockronomicon","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/laurynasgadl/lockronomicon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurynasgadl%2Flockronomicon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurynasgadl%2Flockronomicon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurynasgadl%2Flockronomicon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurynasgadl%2Flockronomicon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/laurynasgadl","download_url":"https://codeload.github.com/laurynasgadl/lockronomicon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurynasgadl%2Flockronomicon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266886779,"owners_count":24001061,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"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":["golang","locking"],"created_at":"2025-07-24T18:33:47.217Z","updated_at":"2025-07-24T18:33:51.401Z","avatar_url":"https://github.com/laurynasgadl.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔏 Lockronomicon\n\nLockronomicon is a simple lock service for distributed systems. It provides a slim HTTP API to a FS-based locking mechanism.\n\n## Installation\n\n### From Source\n```\n\u003e make build\n\u003e ./lockronomicon -h\nUsage of ./lockronomicon:\n  -address string\n        Network address to listen on (default \":80\")\n  -path string\n        FS locker workdir path (default \"/opt/locker\")\n  -v    Binary version\n```\n\n### Docker\nLockronomicon is available as a [Docker image](https://hub.docker.com/r/laurynasgadl/lockronomicon):\n```\ndocker run -p 80:80 laurynasgadl/lockronomicon\n```\n\n## Usage\n\nA lock can be acquired by providing a locking key (pattern [^[\\w.-]+$](https://regex101.com/r/IyvYwa/1)) and lock TTL (seconds). successfully acquiring a lock returns its generation number. This number is used to ensure lock ownership.\n\nLock TTL can be refreshed by providing its key and the generation number - TTL is extended by the original amount.\n\nLocks are released by providing lock key and the generation number.\n\n## API\n\nThere are 4 HTTP endpoints in total:\n\nMETOD   | URL              | PARAMS     | EXPLANATION\n--------|------------------|------------|------------\nGET     | /health          |            | A general health check endpoint\nPOST    | /api/locks       | key, ttl   | For acquiring locks\nPUT     | /api/locks/{key} | generation | For refreshing an owned lock\nDELETE  | /api/locks/{key} | generation | For releasing an owned lock\n\n\n### Checking service health\n```http\nGET /health\n```\n\n##### Responses\nSTATUS | BODY | EXPLANATION\n-------|------|------------\n200 OK | `{\"status\":\"OK\"}` | Service is healthy\n\n##### Example\n```bash\n\u003e curl localhost:80/health\n{\"status\":\"OK\"}\n```\n\n### Acquiring lock\n```http\nPOST /api/locks\n```\n\n##### Params\nNAME | TYPE | EXPLANATION\n-----|------|------------\nkey  | string of pattern `^[\\w.-]+$` | the lock key\nttl  | int | lock's time-to-live in seconds, negative TTL makes the lock immortal\n\n##### Responses\nSTATUS | BODY | EXPLANATION\n-------|------|------------\n200 OK | `{\"generation\":1622184940255602000}` | Lock acquired successfully\n423 Locked | - | Lock already taken\n\n##### Example\n```bash\n\u003e curl -X POST -H \"Content-Type: application/json\" -d '{\"key\":\"example.lock_key_1\",\"ttl\":300}' localhost:80/api/locks\n{\"generation\":1622283840185146846}\n```\n\n### Refreshing lock\n```http\nPUT /api/locks/{key}\n```\n\n##### Params\nNAME | TYPE | EXPLANATION\n-----|------|------------\nkey  | string of pattern `^[\\w.-]+$` | the lock key\ngeneration  | int | lock's generation number returned upon acquiring it\n\n##### Responses\nSTATUS | BODY | EXPLANATION\n-------|------|------------\n200 OK | `{\"generation\":1622189339302681238}` | Lock refreshed successfully, new generation key returned\n412 Precondition Failed | - | Generation number does not match the current one for this lock\n404 Not Found | - | Lock with such key does not exist\n\n##### Example\n```bash\n\u003e curl -X PUT -H \"Content-Type: application/json\" -d '{\"generation\":1622283840185146846}' localhost:80/api/locks/example.lock_key_1\n{\"generation\":1622283979363905515}\n```\n\n### Releasing lock\n```http\nDELETE /api/locks/{key}\n```\n\n##### Params\nNAME | TYPE | EXPLANATION\n-----|------|------------\nkey  | string of pattern `^[\\w.-]+$` | the lock key\ngeneration  | int | lock's generation number returned upon acquiring it\n\n##### Responses\nSTATUS | BODY | EXPLANATION\n-------|------|------------\n200 OK | - | Lock released successfully\n412 Precondition Failed | - | Generation number does not match the current one for this lock\n404 Not Found | - | Lock with such key does not exist\n\n##### Example\n```bash\n\u003e curl -X DELETE -H \"Content-Type: application/json\" -d '{\"generation\":1622283979363905515}' localhost:80/api/locks/example.lock_key_1\n200 OK\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaurynasgadl%2Flockronomicon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaurynasgadl%2Flockronomicon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaurynasgadl%2Flockronomicon/lists"}