Get started now with our QuickStart guide!
See the Quickstart guide to get going with Refocus!
passwordand change the password for that account.
Adminprofile will be able to invite other users. If you want to let users register themselves as Refocus users, an Admin must set the config parameter
By default, there are no IP restrictions for Refocus access. An admin can configure IP restrictions by adding a config var in Heroku with name
IP_WHITELIST and value array of IP ranges, eg.
[ [22.214.171.124, 126.96.36.199], [188.8.131.52, 184.108.40.206], [220.127.116.11, 18.104.22.168] ]. Only the specified IP ranges will be allowed access to Refocus.
A user should sign up with Refocus using register page or POST to /v1/register. Once registered, the user can sign in using Local authentication - username/password on Refocus login page.
Non-SSO users should authenticate with Refocus as described above using Local Authentication.
If Single Sign On (SSO) is configured in Refocus, SSO users can login using 'SSO Login' button on login page. In case of local authentication with username/password, SSO users will be considered as unregistered user unless they sign up using register page or POST to /v1/register. Once an SSO user is registered with SSO username, the user can sign in using local authentication as well.
When using SSO, a placeholder user record is created and added to the database. Specify a dummy password string for these dummy records. This dummy password is never used for authentication.
If you are troubleshooting realtime event handling in a perspective, add query parameter
debug=REALTIME to any perspective URL. This turns on console logging in the browser for all the realtime subject and sample events the perspective receives.
The API is self-documenting based on
./api/v1/swagger.yaml. Start your server and open
MY_HOST:MY_PORT/v1/docs for interactive documentation of all the Refocus API endpoints.
Guidelines on contributing to Refocus are available here.