OAuth Setup Guide - ajgillis04/GillisDockerDepot GitHub Wiki

OAuth Setup Guide

Introduction

OAuth is an open standard for access delegation, commonly used as a way to grant websites or applications limited access to user information without exposing passwords.

Prerequisites

  • Docker installed
  • OAuth container running in your Docker stack

Configuration Steps

Step 1: Accessing the OAuth UI

  1. Open your browser and navigate to http://<your-ip-address>:<port>.
  2. Log in with your OAuth credentials.

Step 2: Initial Setup Wizard

  1. Follow the initial setup wizard to configure basic settings.
  2. Choose your preferred language for the OAuth interface.

Step 3: Creating OAuth Clients

  1. Navigate to the Clients tab.
  2. Click Create New Client.
  3. Enter the client details:
    • Client Name: Give your client a meaningful name.
    • Redirect URI: Enter the redirect URI for the client.
    • Client Secret: Generate a client secret.
  4. Click Save.

Step 4: Configuring Scopes

  1. Navigate to the Scopes tab.
  2. Click Add Scope.
  3. Enter the scope details:
    • Scope Name: Give your scope a meaningful name.
    • Description: Provide a brief description of the scope.
  4. Click Save.

Step 5: Setting Up Authorization Servers

  1. Navigate to the Authorization Servers tab.
  2. Click Add Authorization Server.
  3. Enter the authorization server details:
    • Server Name: Give your server a meaningful name.
    • Authorization Endpoint: Enter the authorization endpoint URL.
    • Token Endpoint: Enter the token endpoint URL.
  4. Click Save.

Step 6: Customizing Settings

  1. Go to the Settings tab.
  2. Customize settings such as token expiration, encryption keys, and logging preferences.
  3. Click Save.

Notes

  • Ensure all paths and environment variables are updated in the oauth.yaml file.
  • Regularly backup your config directory to save your settings.

Troubleshooting

  • Common Issues: List common issues and solutions.
  • Logs: Check OAuth logs for error messages.
  • Support: Link to the OAuth community and support resources.
⚠️ **GitHub.com Fallback** ⚠️