<commit_before>Options
=======

**development.ini** settings

apex.session_secret = sess_secret
  **REQUIRED**, defines the session secret used for Pyramid

apex.auth_secret = auth_secret
  **REQUIRED**, defines the authentication secret used for Pyramid

apex.came_from_route = home
  **REQUIRED**, defines the default home route. Pyramid defaults to home, but
  some installations may use index, etc.

apex.velruse_config = %(here)s/CONFIG.yaml
  **REQUIRED**, location of the Velruse CONFIG.yaml file

apex.recaptcha_public_key = 
  OPTIONAL, REQUIRED if using Recaptcha

apex.recaptcha_private_key = 
  OPTIONAL, REQUIRED if using Recaptcha

apex.use_recaptcha_on_login = false
  OPTIONAL, Display Recaptcha form on Login Page

apex.use_recaptcha_on_forgot = false
  OPTIONAL, Display Recaptcha form on Forgot my Password Page

apex.use_recaptcha_on_reset = false
  OPTIONAL, Display Recaptcha form on Reset my Password Page

apex.use_recaptcha_on_register = true
  OPTIONAL, Display Recaptcha form on Registration Page

apex.provider_exclude = openid
  OPTIONAL, comma separated list to exclude configured providers. The
  value local will exclude local validation

apex.apex_template = project:templates/auth.mako
  OPTIONAL, an optional template for rendering the authentication forms

apex.register_form_class = project.models.form_name
  OPTIONAL, requires DOTTED notation, specifies overloaded form for
  registration

apex.default_user_group = 
  OPTIONAL, If defined, will add the user to this group when created. If
  undefined, users will not be assigned to a group and you'll only have the
  permissions 'view' and 'authenticated'.

apex.create_openid_before =
  OPTIONAL, NOT IMPLEMENTED, since OpenID requests don't allow us to
  override the signup form, we call this function before the OpenID
  Provider call.

apex.create_openid_after =
  OPTIONAL, since OpenID requests don't allow us to override the signup
  form, we call this function after the OpenID callback.

apex.openid_required =
  OPTIONAL, comma separated list of required fields when using OpenID to create
  an account

apex.default_groups = 
  OPTIONAL, comma separated list of group names to create. Defaults to 
  admin,user

apex.log_logins =
  OPTIONAL, boolean flag to log timestamp and IP address on each login.
 
apex.log_login_header =
  OPTIONAL, Default value is to use REMOTE_ADDR, but, if you run behind
  a cache or proxy server, you might need to set this to X-Forwarded-For
  or another header value that contains the Real IP address of the surfer.

apex.use_apex_edit = false
  OPTIONAL, use apex's model form profile edit function. This is a quick,
  simple function.

**Email Settings**

Email Messages that Apex sends can be customized. The following replacements
are made on messages:

* %_email_% - recipient's email

apex.sender_email = 
  OPTIONAL, defaults to <EMAIL>, 

apex.email_validate = false
  OPTIONAL, require email address to be validated before activating account.

apex.email_message_text = apex.lib.libapex.EmailMessageText
  OPTIONAL, dotted class notation containing replacement message text<commit_msg>fix documentation for email message text replacement<commit_after>Options
=======

**development.ini** settings

apex.session_secret = sess_secret
  **REQUIRED**, defines the session secret used for Pyramid

apex.auth_secret = auth_secret
  **REQUIRED**, defines the authentication secret used for Pyramid

apex.came_from_route = home
  **REQUIRED**, defines the default home route. Pyramid defaults to home, but
  some installations may use index, etc.

apex.velruse_config = %(here)s/CONFIG.yaml
  **REQUIRED**, location of the Velruse CONFIG.yaml file

apex.recaptcha_public_key = 
  OPTIONAL, REQUIRED if using Recaptcha

apex.recaptcha_private_key = 
  OPTIONAL, REQUIRED if using Recaptcha

apex.use_recaptcha_on_login = false
  OPTIONAL, Display Recaptcha form on Login Page

apex.use_recaptcha_on_forgot = false
  OPTIONAL, Display Recaptcha form on Forgot my Password Page

apex.use_recaptcha_on_reset = false
  OPTIONAL, Display Recaptcha form on Reset my Password Page

apex.use_recaptcha_on_register = true
  OPTIONAL, Display Recaptcha form on Registration Page

apex.provider_exclude = openid
  OPTIONAL, comma separated list to exclude configured providers. The
  value local will exclude local validation

apex.apex_template = project:templates/auth.mako
  OPTIONAL, an optional template for rendering the authentication forms

apex.register_form_class = project.models.form_name
  OPTIONAL, requires DOTTED notation, specifies overloaded form for
  registration

apex.default_user_group = 
  OPTIONAL, If defined, will add the user to this group when created. If
  undefined, users will not be assigned to a group and you'll only have the
  permissions 'view' and 'authenticated'.

apex.create_openid_before =
  OPTIONAL, NOT IMPLEMENTED, since OpenID requests don't allow us to
  override the signup form, we call this function before the OpenID
  Provider call.

apex.create_openid_after =
  OPTIONAL, since OpenID requests don't allow us to override the signup
  form, we call this function after the OpenID callback.

apex.openid_required =
  OPTIONAL, comma separated list of required fields when using OpenID to create
  an account

apex.default_groups = 
  OPTIONAL, comma separated list of group names to create. Defaults to 
  admin,user

apex.log_logins =
  OPTIONAL, boolean flag to log timestamp and IP address on each login.
 
apex.log_login_header =
  OPTIONAL, Default value is to use REMOTE_ADDR, but, if you run behind
  a cache or proxy server, you might need to set this to X-Forwarded-For
  or another header value that contains the Real IP address of the surfer.

apex.use_apex_edit = false
  OPTIONAL, use apex's model form profile edit function. This is a quick,
  simple function.

**Email Settings**

Email Messages that Apex sends can be customized. The following replacements
are made on messages:

* %_url_% - URL of the Reset Password form

apex.sender_email = 
  OPTIONAL, defaults to <EMAIL>, 

apex.email_validate = false
  OPTIONAL, require email address to be validated before activating account.

apex.email_message_text = apex.lib.libapex.EmailMessageText
  OPTIONAL, dotted class notation containing replacement message text
{'fraction_non_alphanumeric': 0.05280685061845861, 'fraction_numerical': 0.0, 'mean_word_length': 4.676867686768677, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6164915', 'n_tokens_mistral': 1930, 'n_tokens_neox': 1853, 'n_words': 733}