User Registration & OAuth for Self-Hosted Speckle

Eleron96 · 19 February 2025 15:58

Good day,

Is it possible to restrict user registration in a self-hosted instance of Speckle, or to integrate an external OAuth provider for authentication? I would like to understand if these options are feasible and what configurations might be required to implement them.

iainsproat · 20 February 2025 09:12

Hi @Eleron96

Yes, it’s possible to use one or more external providers (Google, GitHub, Entra ID (formerly Azure AD), or OIDC) for authentication to self-hosted Speckle server.

If you have deployed your self-hosted server with Docker Compose, the environment variables to add to the Speckle server service definition are as follows (uncomment and configure as required):

github.com

specklesystems/speckle-server/blob/db7baac746cf6a977b6a9e1cc9358c32ff678b01/packages/server/.env-example#L90-L115


      
          ############################################################
          # Auth strategies
          # At least one needs to be enabled!
          ############################################################
          STRATEGY_LOCAL=true
          
          
# STRATEGY_GITHUB=false
          # GITHUB_CLIENT_ID="-> FILL IN <-"
          # GITHUB_CLIENT_SECRET="-> FILL IN <-"
          
          
# STRATEGY_GOOGLE=false
          # GOOGLE_CLIENT_ID="-> FILL IN <-"
          # GOOGLE_CLIENT_SECRET="-> FILL IN <-"
          
          
# STRATEGY_AZURE_AD=false
          # AZURE_AD_ORG_NAME="-> FILL IN (optional) <-"
          # AZURE_AD_IDENTITY_METADATA="-> FILL IN <-"
          # AZURE_AD_CLIENT_ID="-> FILL IN <-"
          # AZURE_AD_ISSUER="-> FILL IN <-"
          # AZURE_AD_CLIENT_SECRET="-> FILL IN <-"

This file has been truncated. show original

If deploying with Helm Chart for Kubernetes, the values to amend are the server.auth.*, described in detail here: helm

Hope this helps,

Iain

Eleron96 · 20 February 2025 09:34

Thank you for your prompt response. Allow me to ask one more thing: Is it possible to restrict the registration option?

gergo · 20 February 2025 09:35

Yes, the server has an invite only setting, available in the server settings page.