Get started now with our QuickStart guide!
See the Quickstart guide to get going with Refocus!
email@example.com the password you set. Delete the environment variable.
true. This disables the
SESSION_SECRETto sign the session ID cookie. (When deploying on Heroku, this will be generated automatically for you.)
SECRET_TOKENto create jwt tokens used for authentication. (When deploying on Heroku, this will be generated automatically for you.)
CLOCK_JOB_INTERVAL_deleteUnusedTokensto set the frequency of the clock job, i.e. how often should we check for unused tokens. Set the value to a time offset like
12hif you want to run the clock job every twelve hours or
1dif you want to run the job once a day.
DELETE_UNUSED_TOKENS_SINCEto set the threshold of what we should consider "unused". Set the value to a negative time offset like
-30dif you want to consider a token unused if it has not been used in the last 30 days.
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.
[ [220.127.116.11, 18.104.22.168], [22.214.171.124, 126.96.36.199], [188.8.131.52, 184.108.40.206] ]. 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.