5. Login Configuration

With the rest of FaxStore configured, the final major setup task is choosing and configuring a login provider.

FaxStore supports four login methods. This page covers the following providers:

Each section below explains how to create the required OAuth application and where to place the credentials in your FaxStore config.

Discord

Discord is one of the most commonly used login methods and offers several platform integrations that work well with FaxStore. Discord logins complete over 90% of all accounts over every FaxStore instance.

1. Go to the Discord Developer portal and create an application

2. Open the OAuth section and add the below redirect URI, replacing example.com with the chosen domain for FaxStore

https://example.com/auth/discord/callback

3. Copy the credentials required for FaxStore

   1. Client ID

   2. Client Secret

4. Add the credentials into the configuration file and save it

   

GitHub

GitHub is considered one of the easiest methods to setup. However, it also one of the least used with only around 10 users authenticated with it over every FaxStore instance.

1. Open GitHub developer settings and create a new OAuth application

   

2. Fill in the application details and set the OAuth URI to be the below, replacing example.com with the chosen FaxStore domain

https://example.com/auth/github/callback

3. Copy the credentials provided including:

   1. Client ID

   2. Client Secret

4. Add the details into the configuration file and save

Google

Google is often referred to having a more complicated setup. However, the reach of users with a Google account is extremely high.

1. Open the Google developers console

2. Create a new project for FaxStore and provide the requested details
   The create button is located in the top-right corner in the blue dropdown

3. Open credentials and click "Create Credentials" and choose OAuth client ID

4. If prompted, an OAuth consent screen may need to be completed, if so, choose external as the user-type. If selecting scopes ensure the two below are chosen

   1. userinfo.email

   2. userinfo.profile

5. Create the client by going back and choosing web application

6. User "Authorised Redirect URIs" add the below, replacing example.com with the chosen FaxStore domain

https://example.com/auth/google/callback

7. Copy the credentials presented

   1. Client ID

   2. Client Secret

8. Add the copied ID and secret to the configuration file and save

Standard Logins (Username & Password)

Often referred to as a username/email and password login, FaxStore offers Standard logins by default and doesn't require one of the three above OAuth methods to be activated. Standard logins are enabled by default and can be toggled off after the setup has been completed via the staff panel.