README.md

SAML.to Self Hosted

This is the Serverless application to deploy and run SAML.to in any AWS Account.

It consists of two core APIs:

• The auth-sls-rest-api: The Authentication backend, which creates handles GitHub Login and App Installation events.
• The github-sls-rest-api: The GitHub backend, which handles SAML Requests and Respones using GitHub Tokens.

⚠️ Before getting started, please message [email protected] with your AWS Account ID so we can grant access to the Lambda Layers referenced in package.json.

Getting Started

1. Use This Template to create this repository in your own GitHub Account or Organization
2. Follow the Installation Instructions to deploy the Application to your AWS Account.

Deploying

1. Navigate to GitHub Actions for this Project
2. Find the Deploy GitHub Action
3. Click Run Workflow

Accessing API Docs

1. After Deploying you can observe the endpoints of the Service in the GitHub Actions Summary
   1. auth-sls-rest-api: https://somerandomid.execute-api.us-east-1.amazonaws.com/nonlive/auth
   2. github-sls-rest-api: https://hoxumplysi.execute-api.us-east-1.amazonaws.com/nonlive/github
2. You can visit Swagger OpenAPI docs by adding /swagger.html to the URLs
   1. auth-sls-rest-api: https://somerandomid.execute-api.us-east-1.amazonaws.com/nonlive/auth/swagger.html
   2. github-sls-rest-api: https://somerandomid.execute-api.us-east-1.amazonaws.com/nonlive/github/swagger.html

Upgrading Versions

SAML.to uses Semantic Versioning for the Lambda Layers referenced in serverless.yml. Please email [email protected] to be informed of new releases.

1. Edit package.json
2. Within the layers property, update the desired versions for:
   1. github-sls-rest-api
   2. auth-sls-rest-api

Maintainers

• SAML.to
• @cnuss
• Scaffoldly

Terms of Use

By using this repository, you agree to the LICENSE and Terms of Use.

License

BUSL-1.1

Copyright 2024 SAML.to (a subsidiary of Scaffoldly LLC)