Getting Started

How do I get started with Authproject?
How can I get started with Authproject?

Prerequesites

To start with Authproject, you’ll need just a couple of things:

Authentication Domain

This is the primary domain that people will see when they try to log into your application. We recommend it is something short and easy to remember, while also being a subdomain of your main website, like auth.yourdomain.com.

Name

You’ll also need the name of your project. This can be any short string, such as My Project.

DNS Access

You’ll need to be able to create DNS records for your domain. Four records will need to be added - one for the primary domain, and three for emails.


Setup

First, set up the primary authentication domain. This should be nice and simple.

DNS CNAME Setup

Once you have selected the subdomain to use for user authentication, create a DNS CNAME record that goes from your authentication subdomain to prod.authproject.com. For example:

CNAME auth.yourdomain.com prod.authproject.com

DNS Email CNAME Setup

Once you have pointed your authentication subdomain to our servers, we will give you three more CNAMEs to create, so we can send emails on your behalf. These will be restricted to only work on the subdomain you have selected for us - for example, users will receive their email verifications from noreply@auth.yourdomain.com. These must be created before we can fully provision your authentication domain.

HTTPS Setup

Now that your authentication subdomain has been pointed at our servers, we will provision a TLS certificate on our own, to encrypt all data between your users and our services. There are no steps required from your side for this to happen.


Administering Your Domain

When everything is complete, you will be able to see your domain accessible in our dashboard. This means that you will be able to edit and manage users, update administrators, and generally view the overall health of your authentication domain.


OpenID Connect

What is OIDC?

User Info

What is user info, and how do I use it?