Skip to content

README.md

Latest commit

 

History

History
21 lines (16 loc) · 1.95 KB

README.md

File metadata and controls

21 lines (16 loc) · 1.95 KB
Raw

Config

  • automation.conf - generated by the automation configure script. Controls server version, device location label, S3 bucket/prefix, schedule, interval, ModuleGaze collection, and OC4D assessment pull settings.
  • oc4d/student-map.example.csv - format template for optional local student overrides (source_student_name,studentId,parentOrg)
  • oc4d/assessment-map.example.csv - format template for optional local assessment overrides (source_assessment_name,assessmentId,parentOrg)
  • oc4d/student-map.csv and oc4d/assessment-map.csv - generated locally during configure when OC4D assessments are enabled; not shipped in Git. Most installs can leave them as header-only templates because students auto-map from cloud roster/S3 prefixes and assessments auto-generate stable IDs from titles.

Ownership & permissions

  • automation.conf is owned by the service user (typically pi) and chmod 600
  • Local OC4D map files are created from the example templates on first configure and are not overwritten on later configure runs
  • The automation runner reads these files at runtime; use the Configure menu to edit them safely

Keys

  • SERVER_VERSION (v1, v2, v3, or v6), PYTHON_SCRIPT (oc4d or cape_coast_d)
  • DEVICE_LOCATION (label for folder and file naming)
  • S3_BUCKET (s3://bucket), S3_SUBFOLDER (optional), and RACHEL_SUBFOLDER (optional)
  • MODULEGAZE_ENABLED (1 to also collect/process/upload /var/log/modulegaze; 0 to skip)
  • SCHEDULE_TYPE and RUN_INTERVAL
  • OC4D_ASSESSMENTS_ENABLED, OC4D_API_BASE_URL, OC4D_API_TOKEN, OC4D_BUCKET, OC4D_PARENT_ORG, OC4D_UPLOAD_MODE, OC4D_SOURCE_DIR, OC4D_STUDENT_MAP_FILE, OC4D_STUDENT_PREFIX_SYNC, OC4D_CLOUD_STUDENTS_API_BASE_URL, OC4D_CLOUD_API_TOKEN, OC4D_CLOUD_STUDENT_MAP_URL, OC4D_CLOUD_STUDENT_MAP_S3_URI, OC4D_CLOUD_STUDENT_MAP_FILE, OC4D_ASSESSMENT_MAP_FILE, OC4D_STATE_FILE