matrix-org / matrix-user-verification-service

Service to verify details of a user based on a Open ID token.
Other
22 stars 21 forks source link

Clarifying the readme #29

Open rwjack opened 1 year ago

rwjack commented 1 year ago

Hey, I'm having a hard time understanding what's needed to get everything configured:

UVS_ACCESS_TOKEN=syt_foobar ###### foobar is confusing, should this be the access token for an admin user made specifically for this service?
UVS_HOMESERVER_URL=synapse:8008 ###### does this need to be https://matrix.domain.tld # or can it be as shown, since it resides in the same docker network

## OPTIONAL
# Auth token to protect the API
# If this is set any calls to the provided API endpoints
# need have the header "Authorization: Bearer changeme". ###### need to have the header where? do I need to add something here or can this be the same as UVS_ACCESS_TOKEN? The api endpoint is filtered by the proxy, so going directly to synapse:8008 should work. Can it be determined in homeserver.yaml if UVS_AUTH_TOKEN is required here?
UVS_AUTH_TOKEN=syt_foobar ###### add syt_ to reduce confusion
UVS_OPENID_VERIFY_SERVER_NAME=matrix.domain.tld ###### what's this? `curl https://matrix.domain.tld/.well-known/matrix/client`, is it m.homeserver -> base_url? Or is it server_name from homeserver.yaml?

UVS_LISTEN_ADDRESS=0.0.0.0 ###### I'm guessing this is required if UVS needs to be opened to the outside world?
UVS_LOG_LEVEL=debug ###### I'm not seeing any logs still

@jaywink Can you elaborate please?