{"id":20906635,"url":"https://github.com/authress/authress-local","last_synced_at":"2025-05-13T06:33:19.288Z","repository":{"id":184308910,"uuid":"671565227","full_name":"Authress/authress-local","owner":"Authress","description":"Local running version of an Authorization API in a container","archived":false,"fork":false,"pushed_at":"2024-02-01T16:23:41.000Z","size":230,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"release/0.1","last_synced_at":"2024-10-28T17:42:53.812Z","etag":null,"topics":["api","authentication","authorization","authress","container","offline","sdk","security"],"latest_commit_sha":null,"homepage":"https://authress.io","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Authress.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","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}},"created_at":"2023-07-27T15:55:57.000Z","updated_at":"2024-09-28T22:05:57.000Z","dependencies_parsed_at":"2023-12-11T17:29:39.818Z","dependency_job_id":"b15dc782-d45a-4ddf-b56d-c0133ef5f1b5","html_url":"https://github.com/Authress/authress-local","commit_stats":null,"previous_names":["authress/authress-local"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Authress%2Fauthress-local","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Authress%2Fauthress-local/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Authress%2Fauthress-local/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Authress%2Fauthress-local/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Authress","download_url":"https://codeload.github.com/Authress/authress-local/tar.gz/refs/heads/release/0.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225184045,"owners_count":17434244,"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","authorization","authress","container","offline","sdk","security"],"created_at":"2024-11-18T13:34:26.509Z","updated_at":"2024-11-18T13:34:27.249Z","avatar_url":"https://github.com/Authress.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg height=\"300px\" src=\"https://authress.io/static/images/media-banner.png\" alt=\"Authress media banner\"\u003e\n\u003c/p\u003e\n\n# Authress Local\n\nAuthress Local provides a local running version of an Authorization API in a container. Use Docker, Podman, Nomad or another container management solution to run authorization and authentication directly on your localhost.\n\nAuthress local stands up an API that offers parity with the [Authress Authorization API](https://authress.io/app/#/api). You can use Authress local to build authentication and authorization directly into your applications and services.\n\nAdditionally, Authress local is great way to develop with Authress without needing to have an Authress account.\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/Authress/authress-local/pkgs/container/authress-local\" alt=\"Authress Local Container\"\u003e\u003cimg src=\"https://img.shields.io/badge/Container-authress%2Fauthress--local-DC7100.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Authress/authress-local/actions\" alt=\"GitHub action status\"\u003e\u003cimg src=\"https://github.com/authress/authress-local/actions/workflows/build.yml/badge.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"./LICENSE\" alt=\"agpl-3.0 license\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-AGPL3.0-blue.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://authress.io/community\" alt=\"authress community\"\u003e\u003cimg src=\"https://img.shields.io/badge/Community-Authress-fbaf0b.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n## Documentation\n* [Full container documentation](https://authress.io/knowledge-base/docs/SDKs/authress-local)\n\n## Usage\nRun the container locally:\n\n#### Docker\n```sh\ndocker pull authress/authress-local:latest\ndocker run -d -p 8888:8888 authress/authress-local:latest\n# Run in terminal: docker run -d -p 8888:8888 authress/authress-local:latest\n```\n\n#### Podman\n```sh\npodman pull ghcr.io/authress/authress-local:latest\npodman run -d -p 8888:8888 authress/authress-local:latest\n# Run in terminal: podman run -d -p 8888:8888 authress/authress-local:latest\n```\n\nThis will run the container locally on port `8888`, if you want to run the container on a different port, change the `8888` to another port number.\n\nThe api for the running container matches the API at [Authress APi](https://authress.io/app/#/api).\n\nAn example API request to check a user's authorization is:\n\n```bash\ncurl localhost:8888/v1/users/USER/resources/RESOURCE/permissions/PERMISSION\n```\n\nWhere `USER` would be the user, `RESOURCE` is the resource uri,and the `PERMISSION` is the permission. Authress recommends using one of the many [SDKs](https://authress.io/knowledge-base/docs/SDKs) to connect instead. If you are interested in already working starter kits for various languages check out the [Authress starter kits](https://authress.io/knowledge-base/docs/SDKs), they are listed by language.\n\n### Generating a JWT for use with your service\nThe Authress Local container supports dynamically generating valid JWT tokens. Tokens can be also generated by the [Authress Management Portal](https://authress.io/app/#/authress-local?focus=token-generation) if you have internet access. Otherwise, tokens can be generated by the container once it is running.\n\n```bash\ncurl -XPOST -d'{ }' http://localhost:8888/api/authentication\n```\n\nWill return a valid access token in a JSON object:\n```bash\n200\n{\n    \"accessToken\":\n        \"eyJ0eXAiOiJKV1QiLCJhbGciOiJFZERTQSIsImtpZCI6ImF1dGhyZXNzLWxvY2FsIn0.eyJhdWQiOiJsb2NhbGhvc3QiLCJleHAiOjE3MDU4NjIzNjksImlhdCI6MTcwNTc3NTk2OSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4ODg4Iiwic3ViIjoibWUifQ.F_PiFTg7ir0bDhet_AVs6aeIxbBycXUso-J7sUA22iWK6p4pOUFoyMJTr6ZD_GCEQqI314WMmjllK9GZ9spTBQ\"\n}\n```\n\n## Contributing to Authress Local\nWant to contribute to Authress local, check out the [Contribution and Development Guide](./contributing.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthress%2Fauthress-local","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fauthress%2Fauthress-local","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthress%2Fauthress-local/lists"}