Authgear
Start BuildingHomePortalCommunity
  • Authgear Overview
  • Get Started
    • 5-Minute Guide
    • Start Building
    • Single-Page App
      • JavaScript (Web)
      • React
      • Angular
      • Vue
    • Native/Mobile App
      • iOS SDK
      • Android SDK
        • Android Kotlin coroutine support
        • Android OKHttp Interceptor Extension (Optional)
      • Flutter SDK
      • React Native SDK
      • Ionic SDK
      • Xamarin SDK
      • Using Authgear without SDK (Client side)
    • Regular Web App
      • Express
      • Next.js
      • Python Flask App
      • Java Spring Boot
      • ASP.NET Core MVC
      • Laravel
      • PHP
    • Backend/API Integration
      • Client SDK to make authorized API calls to backend
      • Validate JWT in your backend
      • Forward Authentication to Authgear Resolver Endpoint
    • AI Coding tools
      • Cursor/Windsurf
    • Integration by OIDC
    • Integration by SAML
      • Use Authgear as SAML Identity Provider for Salesforce
      • Use Authgear as SAML Identity Provider for Dropbox
      • SAML Attribute Mapping
  • Authentication and Access
    • Authentication
      • Add Passkeys Login
      • Add WhatsApp OTP Login
      • Add Email Magic Link Login
      • Add Biometric Login
      • Add Anonymous Users
      • Enable Two-Factor Authentication (2FA)
      • Re-authentication
      • Set Password Expiry
      • Change Forgot/Reset Password settings
      • Add authentication to any web page
    • Single Sign-on Overview
      • App2App Login
      • App2Web (Pre-authenticated URLs)
      • Web2App (From Mobile Apps to Browsers)
      • Force Authgear to Show Login Page
      • Single Sign-on with OIDC
      • Single Sign-on with SAML
    • Social/Enterprise Login Providers Overview
      • Social Login Providers
        • Connect Apps to Apple
        • Connect Apps to Google
        • Connect Apps to Facebook
        • Connect Apps to GitHub
        • Connect Apps to LinkedIn
        • Connect Apps to WeChat
      • Enterprise Login Providers
        • Connect Apps to Azure Active Directory
        • Connect Apps to Microsoft AD FS
        • Connect Apps to Azure AD B2C
      • Force Social/Enterprise Login Providers to Show Login Screen
  • FAQ for Authentication
    • Tips for Apple App Store Review with Passwordless Login
    • Phone Number Validation
    • Skip Login Screen and Direct Users to Enterprise Login
    • Use the OAuth 2.0 State Parameter
    • Local Dev Setup for Connecting to Authgear SaaS in Cookie-based Auth
  • Integration
    • Add custom fields to a JWT Access Token
    • User Profiles
      • What is User Profile
      • Access User Profiles
      • Update User Profiles
      • Profile Custom Attributes
      • Update user profile on sign-up using Hooks
    • Mobile Apps
      • Force authentication on app launch
      • Customize the Login Pop-up / Disable the login alert box
    • Integration with other Software
      • Integrate Authgear with Firebase
      • Integrate with Google Tag Manager
    • FAQ for Integration
      • How to Track User Before and After Signup?
      • What happens with user directly access the Authgear Endpoint?
  • Customization
    • Built-in UI
      • Branding in Auth UI
      • User Settings
      • Privacy Policy & Terms of Service Links
      • Customer Support Link
      • Custom Text
      • Languages and Localization
    • Custom UI
      • Authentication Flow API
      • Implement Authentication Flow API using Express
      • Implement Authentication Flow API using PHP
      • Add Custom Login/Signup UI to Native Apps
      • Manually Link OAuth Provider using Account Management API
      • Implement a custom account recovery UI using Authentication Flow API
    • Custom Domain
    • Custom Email and SMS Templates
    • Custom Email Provider
    • Custom SMS Provider
      • Twilio
      • Webhook/Custom Script
    • Events and Hooks
      • Event List
      • Webhooks
      • JavaScript / TypeScript Hooks
      • Example: Only Allow Signups from Inside the Corporate Network using Hooks
  • Admin & Operations
    • Monitor
      • Audit Log For Users Activities
      • Audit Log for Admin API and Portal
      • Analytics
    • User Management
      • Account Deletion
      • Import Users using User Import API
      • Export Users using the User Export API
      • Manage Users Roles and Groups
      • How to Handle Password While Creating Accounts for Users
    • Migration
      • Bulk migration
      • Rolling migration
      • Zero-downtime migration
  • Security
    • Brute-force Protection
    • Bot Protection
    • Non-HTTP scheme redirect URI
    • Password Strength
  • Reference
    • APIs
      • Admin API
        • Authentication and Security
        • API Schema
        • API Queries and Mutations
        • Using global node IDs
        • Retrieving users using Admin API
        • API Examples
          • Generate OTP code
          • Search for users
          • Update user's picture
          • Update user's standard attributes
      • Authentication Flow API
      • OAuth 2.0 and OpenID Connect (OIDC)
        • Supported Scopes
        • UserInfo
      • User Import API
      • User Export API
    • Tokens
      • JWT Access Token
      • Refresh Token
    • Rate Limits
      • Account Lockout
    • Glossary
    • Billing FAQ
  • Authgear ONCE
    • What is Authgear ONCE
    • Install Authgear ONCE on a VM
    • Install Authgear ONCE on Amazon Web Services (AWS)
    • Install Authgear ONCE on Vultr
  • Concepts
    • Identity Fundamentals
    • Authgear use cases
    • User, Identity and Authenticator
  • Client App SDKs
    • Javascript SDK Reference
    • iOS SDK Reference
    • Android SDK Reference
    • Flutter SDK Reference
    • Xamarin SDK Reference
  • Deployment
    • Run with Docker
    • Deploy with Helm chart
    • Authenticating HTTP request with Nginx
    • Configuration
      • Environment Variables
      • authgear.yaml
      • authgear.secrets.yaml
    • Architecture Guides
      • AWS Reference Architecture
      • Azure Reference Architecture
      • Google Cloud Reference Architecture
      • Throughput Scaling Reference
  • Troubleshooting
    • How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK
    • How to Fix CORS Error
Powered by GitBook
On this page
  • Prerequisites
  • Step 1: Create an EC2 Instance (Virtual Machine)
  • Step 2: Get Public IP and SSH into the EC2 Virtual Machine
  • Step 3: Set up DNS A Records for Domain Name
  • Step 4: Prepare External Email Provider
  • Step 5: Run Installation Script
  • Step 6. Log in to Your Authgear Portal

Was this helpful?

Edit on GitHub
Export as PDF
  1. Authgear ONCE

Install Authgear ONCE on Amazon Web Services (AWS)

Guide on how to install Authgear ONCE on an AWS EC2 Instance

PreviousInstall Authgear ONCE on a VMNextInstall Authgear ONCE on Vultr

Last updated 19 days ago

Was this helpful?

In this guide, you'll learn how to install Authgear ONCE on a virtual machine hosted on Amazon Web Services (AWS).

Prerequisites

Before you get started, make sure to have the following:

  • First, you need a valid Authgear ONCE license. You can purchase from.

  • An that you'll use to create a virtual machine.

  • A domain name.

  • Sendgrid account or SMTP server.

Step 1: Create an EC2 Instance (Virtual Machine)

Log in to the AWS console.

From the Console home page, click on the three (3) horizontal line icon, then navigate to All services > Compute > EC2.

Next, click on the Launch instance button on the EC2 dashboard.

Enter a name for your instance in the Name and tag field. Then, click on the Browse more AMIs button.

On the Choose an Amazon Machine Image (AMI) page, click on AWS Marketplace AMIs.

Then, enter "docker" in the search box and hit the Enter/Return key.

Select your preferred Linux distro from the search results to continue. For example, Docker on Debian 11. Click on Subscribe on instance launch on the next screen.

Do the following to complete setting up your VM:

  • Create a new RSA (with the .pem file format) login Key pair or select an existing one. Download the key and keep it safe, as you'll be using it to log in to the VM via SSH.

  • Enable both Allow HTTPS traffic from the internet and Allow HTTP traffic from the internet under Network settings. Leave other settings unchanged.

  • Click Launch instance to finish the setup.

Step 2: Get Public IP and SSH into the EC2 Virtual Machine

Once your VM is created, click on Connect to instance to view the public IP address and details for accessing the machine via SSH. Note the public IP address as you'll need it to set up A records for your domain name.

Follow the instructions on the SSH client tab to log in to your VM.

Step 3: Set up DNS A Records for Domain Name

Configure your domain name with the following A records and the public IP address of your VM.

Type
Name
Value
Usage

A

auth

IP of your VM

The authentication endpoint

A

authgear-portal

IP of your VM

The admin portal for CIAM functions

A

authgear-portal-accounts

IP of your VM

A domain for logging into the Authgear portal. You don't need to access it directly.

Step 4: Prepare External Email Provider

Authgear ONCE supports Sendgrid and SMTP server for sending verification and other system emails.

To configure your Authgear ONCE instance to use Sendgrid do the following:

  1. Add a sender address in Sendgrid portal, it should be the address you plan to add as sender in Authgear ONCE.

  2. Create an API key in Sendgrid portal. Note down the API key as you can only view it once.

To use SMTP, create an SMTP server and note the configurations.

Step 5: Run Installation Script

Log in to your VM via SSH and run the installation script. You can find the command for running the script in the Authgear ONCE purchase mail sent to you. The installation command should look like this:

/bin/sh -c "$(curl -fsSL https://once-license-staging.authgear.com/install/470E06-E59449-FA1A3C-AA693D-22CF93-V3)"

The installation script is interactive and will walk you through all the steps for configuring your domain, email provider, and Portal admin account.

Step 6. Log in to Your Authgear Portal

After a successful installation, visit authgear-portal.your-domain.com (change your-domain.com to your actual domain name) to view the admin Portal for your new Authgear instance.

Log in to the portal using the email address and password for the admin account you created during the installation.

authgear.com
AWS account
aws navigatiion menu
AWS Image market place
get vm ip address
Example of A records on Namecheap
Onboarding screen for admin Portal of new Authgear ONCE instance