{"id":13820375,"url":"https://github.com/authorizer-tech/access-controller","last_synced_at":"2025-05-16T10:30:46.317Z","repository":{"id":47454067,"uuid":"365261356","full_name":"authorizer-tech/access-controller","owner":"authorizer-tech","description":"A highly scalable open-source implementation of an access-control engine inspired by Google Zanzibar-\"Google’s Consistent, Global Authorization System\"","archived":false,"fork":false,"pushed_at":"2021-10-26T01:37:21.000Z","size":452,"stargazers_count":71,"open_issues_count":4,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-08-04T08:04:16.636Z","etag":null,"topics":["access-control","access-management","authorization","authorizer","iam","zanzibar"],"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/authorizer-tech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-05-07T14:33:36.000Z","updated_at":"2024-07-03T03:50:11.000Z","dependencies_parsed_at":"2022-09-12T08:50:28.767Z","dependency_job_id":null,"html_url":"https://github.com/authorizer-tech/access-controller","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authorizer-tech%2Faccess-controller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authorizer-tech%2Faccess-controller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authorizer-tech%2Faccess-controller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authorizer-tech%2Faccess-controller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/authorizer-tech","download_url":"https://codeload.github.com/authorizer-tech/access-controller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225423594,"owners_count":17472145,"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":["access-control","access-management","authorization","authorizer","iam","zanzibar"],"created_at":"2024-08-04T08:01:02.249Z","updated_at":"2024-11-19T20:30:26.353Z","avatar_url":"https://github.com/authorizer-tech.png","language":"Go","readme":"# access-controller\n\n[![Latest Release](https://img.shields.io/github/v/release/authorizer-tech/access-controller)](https://github.com/authorizer-tech/access-controller/releases/latest)\n[![Go Report Card](https://goreportcard.com/badge/github.com/authorizer-tech/access-controller)](https://goreportcard.com/report/github.com/authorizer-tech/access-controller)\n[![Slack](https://img.shields.io/badge/slack-%23authorizer--tech-green)](https://authorizer-tech.slack.com)\n\nAn implementation of a distributed access-control server that is based on [Google Zanzibar](https://research.google/pubs/pub48190/) - \"Google's Consistent, Global Authorization System\".\n\nAn instance of an `access-controller` is similar to the `aclserver` implementation called out in the paper. A cluster of access-controllers implement the functional equivalent of the Zanzibar `aclserver` cluster.\n\n# Getting Started\nIf you want to setup an instance of the Authorizer platform as a whole, browse the API References, or just brush up on the concepts and design of the platform, take a look at the [official platform documentation](https://authorizer-tech.github.io/docs/overview/introduction). If you're only interested in running the access-controller then continue on.\n\n## Setup a Cluster\nAn access-controller server supports single node or multi-node (clustered) topologies. Instructions for running the server with these topologies are outlined below.\n\nTo gain the benefits of the distributed query model that the access-controller implements, it is recommend to run a large cluster. Doing so will help distribute query load across more nodes within the cluster. The underlying cluster membership list is based on Hashicorp's [`memberlist`](https://github.com/hashicorp/memberlist)\n\n\u003e a library that manages cluster membership and member failure detection using a gossip based protocol.\n\nA cluster should be able to suport hundreds of nodes. If you find otherwise, please [submit an issue](https://github.com/authorizer-tech/access-controller/issues/new).\n\n### Docker Compose\n[`docker-compose.yml`](./docker/docker-compose.yml) provides an example of how to setup a multi-node cluster using Docker and is a great way to get started quickly.\n\n```console\n$ docker compose -f docker/docker-compose.yml up\n```\n\n### Kubernetes (Recommended)\nTake a look at our [official Helm chart](https://authorizer-tech.github.io/helm-charts/access-controller).\n\n### Pre-compiled Binaries\nDownload the [latest release](https://github.com/authorizer-tech/access-controller/releases/latest) and extract it.\n\n#### Pre-requisites\nTo run an access-controller you must have a running CockroachDB database. Take a look at setting up [CockroachDB with Docker](https://www.cockroachlabs.com/docs/stable/start-a-local-cluster-in-docker-mac.html).\n\n#### Single Node\n```console\n$ ./bin/access-controller\n```\n\n#### Multi-node\nStart a multi-node cluster by starting multiple independent servers and use the `-join` flag\nto join the node to an existing cluster.\n\n```console\n$ ./bin/access-controller -node-port 7946 -grpc-port 50052\n$ ./bin/access-controller -node-port 7947 -grpc-port 50053 -join 127.0.0.1:7946\n$ ./bin/access-controller -node-port 7948 -grpc-port 50054 -join 127.0.0.1:7947\n```\n\n## Next Steps...\nTake a look at the examples of how to:\n* [Add a Namespace Configuration](https://authorizer-tech.github.io/docs/getting-started/add-namespace-config)\n* [Write a Relation Tuple](https://authorizer-tech.github.io/docs/getting-started/write-relation-tuple)\n* [Check a Subject's Access](https://authorizer-tech.github.io/docs/getting-started/check-access)\n\nDon't hesitate to browse the official [Documentation](https://authorizer-tech.github.io/docs/overview/introduction), [API Reference](https://authorizer-tech.github.io/docs/api-reference/overview) and [Examples](https://authorizer-tech.github.io/docs/overview/examples/examples-intro).\n\n# Community\nThe access-controller is an open-source project and we value and welcome new contributors and members\nof the community. Here are ways to get in touch with the community:\n\n* Slack: [#authorizer-tech](https://authorizer-tech.slack.com)\n* Issue Tracker: [GitHub Issues](https://github.com/authorizer-tech/access-controller/issues)","funding_links":[],"categories":["others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthorizer-tech%2Faccess-controller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fauthorizer-tech%2Faccess-controller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthorizer-tech%2Faccess-controller/lists"}