config.example.yaml

####################################################
###  PUT YOUR config.yaml IN src/main/resources  ###
####################################################

# === Required fields ===

# The URL or path to your org file
# Can be supplied by the ORG_FILE environment variable instead
orgFile: "~/path/to/file.org"

# The ID for the Google calendar to be affected
# Can be supplied by the CALENDAR_ID environment variable instead
calendarId: "your-calendar-id@group.calendar.google.com"

# The OAuth refresh token for your Google account, scoped for read/write calendar access
# Can be supplied by the GOOGLE_REFRESH_TOKEN environment variable instead
# If not present, then the `tokens` directory in the current working directory will be used as fallback
googleRefreshToken: "token_here"

# The contents of your credentials.json; if absent, the file at `credentialFile` will be used
# Can be supplied by the GOOGLE_SECRETS environment variable instead
googleSecrets: "{ \"secret\": \"some_secrets_here\" }"


# === Optional fields; default values are shown here ===

# True if `orgFile` is a local path, false if it is a URL
localOrgFile: false

# The path of the headline whose children represent events
orgEventsPath: ""  # "" represents the root of the org document

# The path to your Google API credentials; get this from your admin console
credentialFile: "./credentials.json"

# The keywords for to-do and done tasks respectively
todoKeywords:
  - "TODO"
  - "WAIT"
  - "STRT"
  - "PROJ"
doneKeywords:
  - "DONE"
  - "KILL"

# If true, considers all descendants of the headline, instead of just direct children
flatten: false

# List of tags to be included; if empty, tags are unrestricted
# includeTags considers inherited tags, includeOwnTags does not
includeTags:  # empty
includeOwnTags:  # empty

# List of tags to be ignored
# ignoreTags considers inherited tags, ignoreOwnTags does not
ignoreTags:  # empty
ignoreOwnTags:  # empty

# If true, ignores any headlines marked with a keyword in todoKeywords
ignoreTodos: false

# If false, events marked with a keyword in doneKeywords won't be created
# if they don't already exist in the calendar; existing events will still be updated
createEventsMarkedAsDone: false

# The maximum amount of time (in hours) between now and an event's end time for which
# an event can be removed from the org file *without* being deleted from the calendar.
# Useful if you remove/archive an event on the day but want it to remain in the calendar.
deleteGracePeriod: 24

# The time zone to be assumed for all dates
# e.g. GMT, PST, Europe/London, etc.
timeZone: # null; falls back on system default

# Maps "nicknames" for attendees to their email address
attendeeNicknames:
  # john: "john.smith@example.com"

# Maps sets of tags to event color IDs (see README.md) for event colors
colorMap:
  # "tag1 tag2": 5
  # "tag1": 8