config.yml

Den generelle konfiguration lægges i en YAML-fil ved navn config.yml og denne placeres i enten den folder man kører msml kommandoen fra eller en underfolder til denne ved navn config.

Eksempel på config.yml:

mailinglist: MLMMJ

credentials:
  # Medlemsnummer er brugernavn:
  user: 123456
  password: correcthorsebatterystaple

# Credentials can also be specified in ~/.netrc:
# machine medlem.dds.dk login 123456 password correcthorsebatterystaple

mlmmj:
  # Sudo, ssh, whatever to get to the /usr/bin/mlmmj-* binaries (remember trailing space):
  command_prefix: 'ssh mail.example.net '

I sin simpleste form (credentials står i ~/.netrc og man bruger MLMMJ og har ikke brug for yderligere) kan konfigurationen være helt tom og filen kan udelades.

Efter config.yml er læst kigges der efter en config.override.yml og hvis den findes overskriver værdierne heri værdierne i config.yml. Der ledes efter config.override.yml i samme foldere som efter config.yml.

Mailinglist

mailinglist angiver hvilken mailingliste-software der skal synkroniseres til.

MLMMJ er default og man behøver ikke angive den. Det er også den eneste der er implementeret endnu.

Man kan implementere sin egen mailingliste-funktionalitet. Det er en PHP-klasse der skal overholder MailingListInterface interfacet.

Eventuelt kan man extende AbstractMailingList.

Hvis man implementerer sin egen klasse angiver man klassenavnet ud for mailinglist i sin config.yml (namespacet kan udelades hvis det er MSML\MailingList).

Credentials

Brugernavn og password til Medlemsservice angives under credentials. Brugernavnet er dit medlemsnummer.

Alternativt kan brugernavn og password tilføjes i ~/.netrc.

MLMMJ

MLMMJ kan konfigureres yderligere.

Hvis ikke MLMMJ er installeret på den maskine man kører /usr/bin/mlmmj-* kommandoerne på eller hvis de fx kræver sudo(1) for at have de rette rettigheder kan man angive hvad kommandoerne skal prefixes med for at lykkedes.