AllSiteSettings#
- class AllSiteSettings[source]#
The JSON representation of all options.
-
auto_test_heartbeat_interval:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time there can be between two heartbeats of a runner. Changing this to a lower value might cause some runners to crash.
-
auto_test_heartbeat_max_missed:
Union[Just[int],_Nothing[int]] = Nothing# The max amount of heartbeats that we may miss from a runner before we kill it and start a new one.
-
auto_test_max_jobs_per_runner:
Union[Just[int],_Nothing[int]] = Nothing# This value determines the amount of runners we request for a single assignment. The amount of runners requested is equal to the amount of students not yet started divided by this value.
-
auto_test_max_concurrent_batch_runs:
Union[Just[int],_Nothing[int]] = Nothing# The maximum amount of batch AutoTest runs we will do at a time. AutoTest batch runs are runs that are done after the deadline for configurations that have hidden tests. Increasing this variable might cause heavy server load.
-
auto_test_max_result_not_started:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum amount of time a result can be in the “not started” state before we raise an alarm on the about health page.
-
auto_test_max_unit_test_metadata_length:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of metadata stored on a unit test step.
-
new_auto_test_max_dynamodb_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of an AutoTest 2.0 configuration in the database.
-
new_auto_test_max_storage_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum compound size of all the files uploaded as part of an AutoTest 2.0 configuration.
-
new_auto_test_max_file_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of a single file part of an AutoTest 2.0 configuration.
-
new_auto_test_build_output_limit:
Union[Just[int],_Nothing[int]] = Nothing# The max output a command from a build step is allowed to output before output is truncated.
-
new_auto_test_test_output_limit:
Union[Just[int],_Nothing[int]] = Nothing# The max output a command from a test step is allowed to output before output is truncated.
-
new_auto_test_max_output_files_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum combined file size of files uploaded in the Output step after compression.
-
new_auto_test_allowed_initial_build_ids:
Union[Just[Sequence[str]],_Nothing[Sequence[str]]] = Nothing# The IDs of the available base images for AutoTest 2.0.
-
new_auto_test_initial_build_id:
Union[Just[str],_Nothing[str]] = Nothing# Unused, use NEW_AUTO_TEST_CURRENT_INITIAL_BUILD_IDS.
-
min_password_score:
Union[Just[int],_Nothing[int]] = Nothing# The minimum strength passwords by users should have. The higher this value the stronger the password should be. When increasing the strength all users with too weak passwords will be shown a warning on the next login.
-
setting_token_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time the link send in notification emails to change the notification preferences works to actually change the notifications.
-
max_number_of_files:
Union[Just[int],_Nothing[int]] = Nothing# The maximum amount of files and directories allowed in a single archive.
-
max_large_upload_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of uploaded files that are mostly uploaded by “trusted” users. Examples of these kind of files include AutoTest fixtures and plagiarism base code.
-
max_normal_upload_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum total size of uploaded files that are uploaded by normal users. This is also the maximum total size of submissions. Increasing this size might cause a hosting costs to increase.
-
max_dynamo_submission_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum total size of files part of an editor submission in dynamodb. This is not the same as MAX_NORMAL_UPLOAD_SIZE. Increasing this size might cause a hosting costs to increase.
-
max_file_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of a single file uploaded by normal users. This limit is really here to prevent users from uploading extremely large files which can’t really be downloaded/shown anyway.
-
max_dynamo_file_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of a single file’s updates in dynamodb. This is not the same as MAX_FILE_SIZE. This limit is to avoid having huge files stored in dynamodb, as storage is expensive.
-
max_document_update_size:
Union[Just[int],_Nothing[int]] = Nothing# The maximum size of a single update (CRDT) to a file in dynamodb. This is not the same as MAX_DYNAMO_FILE_SIZE, as it refers to a single edit operation. This limit is to avoid having huge items stored in dynamodb, as storage is expensive. If the CRDT exceeds the given size, it will be uploaded to a S3 object.
-
jwt_access_token_expires:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The time a login session is valid. After this amount of time a user will always need to re-authenticate.
-
sso_username_decollision_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether username decollision - adding a number after the username if it already exists - should be enabled for SSO tenants.
-
max_user_setting_amount:
Union[Just[int],_Nothing[int]] = Nothing# The maximum number of user settings stored per user.
-
send_registration_email:
Union[Just[bool],_Nothing[bool]] = Nothing# Should a registration email be sent to new users upon registration.
-
automatic_lti_1p3_assignment_import:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether CodeGrade should try to automatically copy over assignment settings when it is detected that the course of an assignment is copied from another course within the same LTI provider.
-
lti_unset_deadline_lock_date_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Wether to allow LTI to unset the deadline and lockdate of an assignment.
-
lti_1p3_system_role_from_context_role:
Union[Just[bool],_Nothing[bool]] = Nothing# Also look at context roles when determining the system role for a new user in LMSes that have an extra_roles_mapping defined in their lms_capabilities.
-
lti_1p3_parse_most_privileged_role:
Union[Just[bool],_Nothing[bool]] = Nothing# Prefer the most privileged role in the LTI 1.3 roles claim sent by the LMS, instead of the first role that matches any of our definitions.
-
lti_launch_data_logging:
Union[Just[bool],_Nothing[bool]] = Nothing# Enable logging of LTI launch data. NEVER ENABLE THIS SITE-WIDE, only for a single tenant, and disable this feature after you’ve gotten the data you need.
-
pearson_templates:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether or not pearson templates should be enabled.
-
default_course_teacher_role:
Union[Just[Literal['Full Teacher','Non-Editing Teacher']],_Nothing[Literal['Full Teacher','Non-Editing Teacher']]] = Nothing# The teacher role to be used for teachers in new courses. Existing courses will not be affected.
-
default_course_ta_role:
Union[Just[Literal['Full TA','Non-Editing TA']],_Nothing[Literal['Full TA','Non-Editing TA']]] = Nothing# The TA role to be used for TAs in new courses. Existing courses will not be affected.
-
lti_1p3_nonce_and_state_validation_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether LTI 1.3 launches using cookies (and sessions) should check for correct nonce and state. When disabling this feature flag, please be mindful. These validations protect us from certain attacks. If unsure, consult with the Security Officer before disabling.
-
lti_1p3_prevent_nonce_reuse_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether LTI 1.3 launches should check nonces against the cached value. Enabling this prevents replay attacks. If unsure, consult with the Security Officer before disabling.
-
name_and_email_from_nrps_only:
Union[Just[bool],_Nothing[bool]] = Nothing# Do not store names and emails of users, but always retrieve them through NRPS.
-
always_update_pii_with_lti:
Union[Just[bool],_Nothing[bool]] = Nothing# Should we always update names and emails on LTI launches, or just when indicated and on the first launch.
-
hubspot_syncing_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should we sync teachers to Hubspot.
-
is_pearson:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether we are running Codegrade for Pearson specifically, flag aligns all the smallest adjustments needed that cannot be made into an actual feature.
-
lti_role_switching:
Union[Just[bool],_Nothing[bool]] = Nothing# This enables if we change the role of a user in a course when a launch is done for a different role than the user currently has.
-
access_token_modal_warning_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time before an access token expires when we will show a modal with a warning that the user’s session is about to expire.
-
access_token_toast_warning_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time before an access token expires when we will show a toast message warning the user that their session is about to expire.
-
ai_assistant_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# The main feature flag for all the AI assistant capabilities in codegrade, whether we enable the ai assistant to be inside the app.
-
assignment_default_grading_scale:
Union[Just[Literal['percentage','points']],_Nothing[Literal['percentage','points']]] = Nothing# The default value for the grading scale of new assignments.
-
assignment_default_grading_scale_points:
Union[Just[Fraction],_Nothing[Fraction]] = Nothing# The default points grading scale points of new assignments.
-
assignment_description_on_teachers_submissions_page:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to show the assignment description on the submissions page for teachers.
-
assignment_max_points_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the “Max Points” field within the assignment general settings is enabled. If disabled, teachers will not be able to award extra points for assignments.
-
assignment_percentage_decimals:
Union[Just[int],_Nothing[int]] = Nothing# Number of decimals for percentage-based grades in assignments, this also determines which decimal position the grade is rounded to.
-
assignment_point_decimals:
Union[Just[int],_Nothing[int]] = Nothing# Number of decimals for point-based grades in assignments, this also determines which decimal position the grade is rounded to.
-
assistant_tools_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the AI assistant in the app has access to tools to retrieve more information through requesting tool use while conversing with a user.
-
at_image_caching_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should AT image caching be enabled.
-
auto_test_capture_points_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for Capture Points steps of an AutoTest.
-
auto_test_checkpoint_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for Checkpoint steps of an AutoTest.
-
auto_test_code_quality_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for Code Quality steps of an AutoTest.
-
auto_test_io_test_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for IO Test steps of an AutoTest.
-
auto_test_io_test_sub_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for IO Test sub-steps of an AutoTest.
-
auto_test_max_global_setup_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum amount of time that the global setup script in AutoTest may take. If it takes longer than this it will be killed and the run will fail.
-
auto_test_max_per_student_setup_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum amount of time that the per student setup script in AutoTest may take. If it takes longer than this it will be killed and the result of the student will be in the state “timed-out”.
-
auto_test_max_time_command:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The default amount of time a step/substep in AutoTest can run. This can be overridden by the teacher.
-
auto_test_run_program_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for Run Program steps of an AutoTest.
-
auto_test_unit_test_message:
Union[Just[str],_Nothing[str]] = Nothing# Default message for Unit Test steps of an AutoTest.
-
blackboard_zip_upload_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# If enabled teachers are allowed to bulk upload submissions (and create users) using a zip file in a format created by Blackboard.
-
canvas_course_id_copying_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should course id form Canvas be copied through LTI(1.3), and stored in our database or not.
-
code_editor_output_viewer_title:
Union[Just[str],_Nothing[str]] = Nothing# Title for the output viewer in the code editor when we run the ATv2 config.
-
code_editor_start_on_assignment_description:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to open the assignment description as the first file in the Code Editor, if the assignment has one, or the first file in the file tree.
-
community_library:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the community library is enabled and available.
-
community_library_publishing:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether it is possible to publish new items to the community library. This feature only has effect when COMMUNITY_LIBRARY is enabled too.
-
course_bulk_register_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether it is possible for teachers to create links for batches of users that can be used to register in a course. Links to enroll can be created even if this feature is disabled.
-
course_gradebook_render_warning_size:
Union[Just[int],_Nothing[int]] = Nothing# The minimum size of a gradebook before we show a warning that there are so many entries in the gradebook that it may slow down rendering or crash the page.
-
course_register_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should it be possible for teachers to create links that users can use to register in a course. Links to enroll can be created even if this feature is disabled.
-
csv_large_file_limit:
Union[Just[int],_Nothing[int]] = Nothing# The file size above which users will be shown a warning that parsing the file might cause a slow down in their browser.
-
csv_too_many_errors_limit:
Union[Just[int],_Nothing[int]] = Nothing# The amount of errors that occur above which we will ask the user to make sure that the given file is actually a CSV.
-
default_submission_page_tab:
Union[Just[Literal['auto-test','code','feedback-overview','peer-feedback','smart']],_Nothing[Literal['auto-test','code','feedback-overview','peer-feedback','smart']]] = Nothing# The default tab to select when going to a submission.
-
display_grades_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether we should show the grades of submissions created within this tenant. This will not hide the rubric results, only the grades. This is meant to be used with LTI providers that apply penalties (for example when handing in late) outside of CodeGrade.
-
editor_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Can students submit using the online editor.
-
email_students_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should it be possible to email students.
-
exam_login_max_length:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum time-delta an exam may take. Increasing this value also increases the maximum amount of time the login tokens send via email are valid. Therefore, you should make this too long.
-
feedback_threads_initially_collapsed:
Union[Just[int],_Nothing[int]] = Nothing# Feedback threads will start collapsed from this depth of the tree.
-
first_day_of_week_from_locale:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to get the first day of the week in calendars from the user’s configured locale. If disabled the first day of the week will default to Sunday.
-
github_template_repo_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to allow teachers to provide an URL of a GitHub repo, to be forked by the students when they setup a new repository via the GitHub integration.
-
grading_notifications_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether teachers have access to the assignment manager - notifications panel, which gives control over when to send notifications to graders to finish their job, and also allows teachers to provide email(s) to notify when all graders are finished.
-
hide_code_editor_filetree_controls_with_only_quiz_steps:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether we will hide the buttons to add a file and a directory in the code editor, if we have a quiz-only atv2 config.
-
hide_code_editor_output_viewer_with_only_quiz_steps:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether we will hide all of the steps in the code editor sidebar output viewer if we have in a quiz-only atv2 config.
-
hide_empty_rubric_row_description:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether we hide the rubric row description space in the rubric viewer if the description is empty.
-
hide_no_deadline_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should we hide the “No deadline” message if no deadline or lock date is set.
-
inline_feedback_on_quizzes_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to allow giving inline feedback on quiz questions.
-
inline_rubric_viewer_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the submission rubric viewer uses inline when the tab view does not fit. On the submission page we show the rubric viewer that will allow the teacher to fill in the rubric and the student to view their score in the different categories. With this feature enabled, we calculate whether all of the categories fit on a single line, and otherwise use a dropdown with previous and next buttons to select categories.
-
is_admin_permission_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the is_admin global permission should be enabled. Users with a global role with this permission automatically get all permissions, everywhere. Users with a tenant role with this permission automatically get all permissions within their tenant.
-
jupyter_notebook_editor_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the Jupyter Notebook editor is enabled in the Code Editor. Note: after disabling this feature, existing Jupyter Notebooks will still continue to use the Jupyter Notebook editor.
-
jupyter_notebook_running_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the Jupyter Notebook can be run in the Code Editor. Note: Disabling this feature does not prevent Jupyter Notebooks from being viewed. For that, see the JUPYTER_NOTEBOOK_EDITOR_ENABLED site setting.
-
login_token_before_time:
Union[Just[Sequence[timedelta]],_Nothing[Sequence[timedelta]]] = Nothing# This determines how long before the exam we will send the login emails to the students (only when enabled of course).
-
lti_lock_date_copying_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should the lock date be copied from the LMS through LTI, or should we allow the user to set it in CodeGrade.
-
max_lines:
Union[Just[int],_Nothing[int]] = Nothing# The maximum amount of lines that we should in render in one go. If a file contains more lines than this we will show a warning asking the user what to do.
-
max_plagiarism_matches:
Union[Just[int],_Nothing[int]] = Nothing# The maximum amount of matches of a plagiarism run that we will store. If there are more matches than this they will be discarded.
-
new_auto_test_build_max_command_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum time a command may run in the build part of AutoTest 2.0.
-
new_auto_test_current_initial_build_ids:
Union[Just[Sequence[str]],_Nothing[Sequence[str]]] = Nothing# The IDs of the currently recent base images for AutoTest 2.0. These are the images that we want users to use for new AutoTest 2.0 configurations. Make sure that if you add something to this list it is also added to NEW_AUTO_TEST_ALLOWED_INITIAL_BUILD_IDS, as otherwise the user is not allowed to use the image. The last item in this list will be the default image id.
-
new_auto_test_diff_viewer_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the diff viewer should be shown in AutoTest v2 IO Test steps.
-
new_auto_test_old_submission_age:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum age a submission can be before we do not retry subscribing to its result if it cannot be found the first time.
-
new_auto_test_test_max_command_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum time a command may run in the test part of AutoTest 2.0. This is also the default value for timeout steps.
-
new_auto_test_uncollapsing_step_output_delay:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time that the step will run before its output will automatically uncollapse in the output viewer unless the user has toggled the collapse themselves.
-
notification_poll_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time to wait between two consecutive polls to see if a user has new notifications. Setting this value too low will cause unnecessary stress on the server.
-
output_viewer_animation_limit_lines_count:
Union[Just[int],_Nothing[int]] = Nothing# How many lines of output we will still animate using the collapseable body in ATv2 output viewer.
-
output_viewer_auto_expand_failed_steps:
Union[Just[int],_Nothing[int]] = Nothing# How many steps in the failed state to expand automatically. Set to a negative value to automatically expand all steps.
-
peer_feedback_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should peer feedback be enabled.
-
prompt_engineering_step_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# The main feature flag for the ATv2 prompt engineering step. If enabled the step will be available within the AutoTestv2 editor.
-
quality_comments_in_code_editor:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether quality comments generated by code editor ATv2 runs should be displayed in the editor.
-
quiz_single_question_mode_hide_run_button_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether to hide the “▶️ Run” button in the editor sidebar when an assignment contains only quizzes with the “Run single questions” feature enabled.
-
register_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should it be possible to register on the website. This makes it possible for any body to register an account on the website.
-
release_message_max_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# What is the maximum amount of time after a release a message should be shown on the HomeGrid. Note: this is the amount of time after the release, not after this instance has been upgraded to this release.
-
render_html_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should it be possible to render html files within CodeGrade. This opens up more attack surfaces as it is now possible by design for students to run javascript. This is all done in a sandboxed iframe but still.
-
reset_token_time:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The amount of time a reset token is valid. You should not increase this value too much as users might be not be too careful with these tokens. Increasing this value will allow all existing tokens to live longer.
-
retry_group_submission_grade_passback_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should we retry passing back grades for group submissions when the passback request failed for some but not all of the group members.
-
rubric_enabled_for_teacher_on_submissions_page:
Union[Just[bool],_Nothing[bool]] = Nothing# If enabled teachers can view rubrics on the submissions list page. Here they have the student view version of the rubric as apposed to the editor view in the manage assignment page.
-
server_time_correction_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether the time as detected locally on a user’s computer is corrected by the difference with the time as reported by the backend server.
-
server_time_diff_tolerance:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The maximum amount of difference between the server time and the local time before we consider the local time to be out of sync with our servers.
-
server_time_sync_interval:
Union[Just[timedelta],_Nothing[timedelta]] = Nothing# The interval at which we request the server time in case it is out of sync with the local time.
Whether we update the simple submission mode navigation to check if we have an editor session which is later than the submission when we launch the assignment. This feature is only available when the simple submission mode is enabled. Be mindful of turning this on when the tenant uses deadlines.
-
site_email:
Union[Just[str],_Nothing[str]] = Nothing# The email shown to users as the email of CodeGrade.
-
sso_infer_global_staff_role:
Union[Just[bool],_Nothing[bool]] = Nothing# Whether during an SSO launch new user are granted their global role based on the SSO launch data.
-
student_payment_enabled:
Union[Just[bool],_Nothing[bool]] = Nothing# Should it be possible to let students pay for a course. Please note that to enable this deploy config needs to be updated, so don’t just enable it.
-
auto_test_heartbeat_interval: