From 9420423e1a699bd75b2f672a5f662f18570b3804 Mon Sep 17 00:00:00 2001 From: "zia.fazal@arbisoft.com" Date: Tue, 16 Feb 2021 15:19:17 +0500 Subject: [PATCH] Added annotations for EMBARGO feature flag --- lms/envs/common.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 0a1824ba91..a45c8003b2 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -404,8 +404,18 @@ FEATURES = { # Hide any Personally Identifiable Information from application logs 'SQUELCH_PII_IN_LOGS': True, - # Toggles the embargo functionality, which blocks users from - # the site or courses based on their location. + # .. toggle_name: FEATURES['EMBARGO'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Turns on embargo functionality, which blocks users from + # the site or courses based on their location. Embargo can restrict users by states + # and whitelist/blacklist (IP Addresses (ie. 10.0.0.0), Networks (ie. 10.0.0.0/24)), or the user profile country. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2014-02-27 + # .. toggle_target_removal_date: None + # .. toggle_warnings: reverse proxy should be configured appropriately for example Client IP address headers + # (e.g HTTP_X_FORWARDED_FOR) should be configured. + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2749 'EMBARGO': False, # Whether the Wiki subsystem should be accessible via the direct /wiki/ paths. Setting this to True means