Skip to content

Configuratuon Reference

Maxim Thomas edited this page Aug 9, 2022 · 2 revisions

Gortas can be configured via yaml file

Configuration Example
flows:
  login:
    modules:
      - id: "login"
        type: "login"
        properties:
  registration:
    modules:
      - id: "registration"
        type: "registration"
        properties:
          primaryField:
            dataStore: "email"
            name: "email"
            prompt: "Email"
          additionalFields:
            - dataStore: "name"
              prompt: "Name"
              name: "name"

userDataStore:
  type: "mongodb"
  properties:
    url:  "mongodb://root:changeme@localhost:27017"
    database:   "users"
    collection: "users"
    userAttributes:
      - "name"
      - "email"

session:
  type: "stateful" #could be also stateful
  expires: 60000
  dataStore:
    type: "mongo"
    properties:
      url: "mongodb://root:changeme@localhost:27017"
      database:   "session"
      collection: "sessions"

server:
  cors:
    allowedOrigins:
      - http://localhost:3000


There are some important sections:

  • flows - defines authentication flow, should contain one or more modules
  • modules - authentication module collection
  • userDataStore - user data store settings
  • session - defines session settings
    • type - session type, could be stateful and stateless
    • espires - session lifetime in milliseconds
    • dataStore - session datastore settings
  • server - server settings, defines CORS policy
Clone this wiki locally