How Tos

• How to: Add more preferences
• How to change site-specific settings
  • Variant 1: Using environment variables in the shell
  • Variant 2: Using a settings.py file
• Howto: Write a changelog entry
• Howto: Write a good commit message
  • Temporary commit messages
  • Permanent commit messages
    • First line
    • Context and more info
    • Collaborators
  • How to squash commits
• How to customize filtering
  • Contents of argus.filter.defaults
    • Matching one incident to multiple filters
      • FilterWrapper
      • FallbackFilterWrapper
      • ComplexFilterWrapper
      • ComplexFallbackFilterWrapper
    • Matching a filter to multiple incidents
      • QuerySetFilter
    • API GET-parameters
      • IncidentFilter
      • SourceLockedIncidentFilter
      • INCIDENT_OPENAPI_PARAMETER_DESCRIPTIONS
      • SOURCE_LOCKED_INCIDENT_OPENAPI_PARAMETER_DESCRIPTIONS
    • Serializers
      • FilterSerializer
      • FilterBlobSerializer
    • Validators
      • validate_jsonfilter
• How to add federated login
  • Externally by setting REMOTE_USER
  • Internally with the help of a library
    • SAML
    • OIDC
    • OAuth2
      • Choose an OAUth2-provider
      • Update urls.py
      • Example: Github Backend
        • Get the key and secret for the provider
      • Test
        • Get and test the login url for the backend
        • Derive and test the logout url for the backend
• How Tos for the HTMx Frontend
  • How to make a column for an ack with a known group
  • How to make a column for a specific tag
  • How to customize incident actions
    • Customize an existing action
    • Adding a new action
    • Removing an existing action
  • How to customize filtering the incidents list
    • Filterable columns
  • Upgrading HTMX to a new version
  • Upgrading Hyperscript to a new version
  • Temporarily using a different version
  • How to use Font Awesome icons
  • Override templates
    • Use cases for overriding templates
• Howto: Safely test sending of notifications
  • Testing filters, profiles, timeslots regardless of destination type
    • Automated tests
  • Redirect email to console
    • Automated tests
  • Testing something that fails in production
  • Deactivate profiles you are not testing
    • Automated tests
  • Testing specific destination types
    • Email is not delivered
  • Making test incidents to trigger the notification system
• Howto: Recover from migration trouble
• How to regenerate the ER diagram
  • Get dependencies
  • Test by making a .dot-file
  • Generate PNG
    • Generate via the graph_models command
    • Use graphviz directly on a .dot-file
  • Commit!
• How To: Make a new release
  • Choosing a version number
  • Checklist
• How to toggle the usage of django-debug-toolbar on and off
  • Set up
    • Make sure it is installed
    • Set up extra-apps with django-debug-toolbar
    • Activate the django-debug-toolbar config via the environment
    • Deactivate the django-debug-toolbar config via the environment
  • Toggle
    • Toggle an activated django-debug-toolbar on
    • Toggle an activated django-debug-toolbar off
• How to vendor a git repo
  • Prep the ORIGIN repo
  • Fix up the TARGET repo
  • Transferring Github issues
  • Move Github PR
  • Move other branches from ORIGIN to TARGET
    • Prep code in ORIGIN
    • Setup the remote in the ORIGIN repo
    • Move the actual branch
    • Make a new PR