{"id":25519666,"url":"https://github.com/aligent/serverless-magento","last_synced_at":"2025-12-22T09:30:17.060Z","repository":{"id":36964364,"uuid":"383361511","full_name":"aligent/serverless-magento","owner":"aligent","description":"A Serverless framework plugin for handling registration with the aligent/magento2-microservice-config module.","archived":false,"fork":false,"pushed_at":"2024-03-04T04:08:34.000Z","size":611,"stargazers_count":0,"open_issues_count":7,"forks_count":2,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-02-16T13:24:05.395Z","etag":null,"topics":["aws","magento","magento2","serverless"],"latest_commit_sha":null,"homepage":"https://www.aligent.com.au/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-07-06T06:20:02.000Z","updated_at":"2022-06-20T07:13:49.000Z","dependencies_parsed_at":"2024-02-09T05:30:57.836Z","dependency_job_id":"cfd7357d-607b-4289-98b6-81dd9b6cef4a","html_url":"https://github.com/aligent/serverless-magento","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-magento","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-magento/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-magento/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-magento/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/serverless-magento/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239703244,"owners_count":19683236,"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":["aws","magento","magento2","serverless"],"created_at":"2025-02-19T17:29:19.594Z","updated_at":"2025-12-22T09:30:16.995Z","avatar_url":"https://github.com/aligent.png","language":"TypeScript","readme":"# Serverless Magento\n\nA [Serverless framework](https://www.serverless.com) plugin for handling the registration of a microservices with the [magento2-microservice-config](https://bitbucket.org/aligent/magento2-microservice-config) module.\n\n## Why?\n\nMicroservices registered with the [magento2-microservice-config](https://bitbucket.org/aligent/magento2-microservice-config) module will have a [Magento authentication token](https://devdocs.magento.com/guides/v2.4/get-started/authentication/gs-authentication-token.html) made available via [AWS SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html). This removes the need to manually create Magento integrations / access tokens for each service. The registration also provides the opportunity to create an \"admin\" interface within the Magento admin interface which can be used for managing the serverless application.\n\n## Admin Interface\n\nThe admin interface is provided as a link to an externally hosted web application which is rendered in the Magento admin interface as an `iframe`. Authorisation context will be injected into the iframe when loaded.\n\n## Deployment\n\nThe Serverless plugin will initially register with the [magento2-microservice-config](https://bitbucket.org/aligent/magento2-microservice-config) REST API. At this state the service is \"registered\" but not \"active\". A service does not become \"active\" until an admin user approves it.\n\n## Serverless configuration\n\nThe plugin is configured within the `serverless.yaml` by providing configuration values.\n\n### Example\n\n```yaml\ncustom:\n  serviceRegistration:\n    magentoUrl: https://magento.domain.name\n    magentoApiToken: ${ssm:/magento/api/access-token-for-registration}\n    displayName: Service name that appears in Magento Admin\n    permissions:\n      - Magento_Backend::all\n```\n\n### Variables\n\n| Variable              | Type    | Usage                                                                                                           |\n| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------- |\n| magentoUrl            | string  | The base URL - including scheme - of the Magento instance.                                                      |\n| magentoApiToken       | string  | The api token for registering with Magento instance.                                                            |\n| displayName           | string  | The name of the application/service.                                                                            |\n| description           | string  | Short description about the application/service. If not provided, `resources/Description` will be used          |\n| permission            | string  | Array of Magento permission. Webapp does not need this.                                                         |\n| domainOutputKeyPrefix | string  | The prefix of webapp domain output key. The default value is `landingDomain`.                                   |\n| errorOnFailure        | boolean | Whether the plugin should throw an error when a call to the Magento instance fails. The default value is `true` |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fserverless-magento","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fserverless-magento","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fserverless-magento/lists"}