open-source-mirrors
/
homepage
mirror of https://github.com/benphelps/homepage
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1f2081af5d'
${ noResults }
homepage/docs/widgets/services/calendar.md

2.6 KiB
Raw Blame History

title description
Calendar Calendar widget

Monthly view

calendar

This widget shows monthly calendar, with optional integrations to show events from supported widgets.

widget:
  type: calendar
  firstDayInWeek: sunday # optional - defaults to monday
  view: monthly # optional - possible values monthly, agenda
  maxEvents: 10 # optional - defaults to 10
  showTime: true # optional - show time for event happening today - defaults to false
  integrations: # optional
    - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical
      service_group: Media # group name where widget exists
      service_name: Sonarr # service name for that widget
      color: teal # optional - defaults to pre-defined color for the service (teal for sonarr)
      params: # optional - additional params for the service
        unmonitored: true # optional - defaults to false, used with *arr stack
    - type: ical # Show calendar events from another service
      url: https://domain.url/with/link/to.ics # URL with calendar events
      name: My Events # required - name for these calendar events
      color: zinc # optional - defaults to pre-defined color for the service (zinc for ical)
      timezone: America/Los_Angeles # optional - force timezone for events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)
      params: # optional - additional params for the service
        showName: true # optional - show name before event title in event line - defaults to false

Agenda

This view shows only list of events from configured integrations

widget:
  type: calendar
  view: agenda
  maxEvents: 10 # optional - defaults to 10
  showTime: true # optional - show time for event happening today - defaults to false
  previousDays: 3 # optional - shows events since three days ago - defaults to 0
  integrations: # same as in Monthly view example

Integrations

Currently integrated widgets are sonarr, radarr, lidarr and readarr.

Supported colors can be found on color palette.

iCal

This custom integration allows you to show events from any calendar that supports iCal format, for example, Google Calendar (go to Settings, select specific calendar, go to Integrate calendar, copy URL from Public Address in iCal format).