Server

Calendar API uses a yaml configuration file allowing you to specify your server-settings, iCal calendars to subscribe, as well as rules that are applied to calendar events.

Tips

You can place your config.yaml file in one of the following directories, that CalendarAPI looks up in the same order:

./ (local directory)
- config.yaml
- calendarapi (binary)
~/
- .config/
  - calendarapi/
    - config.yaml
/data/
- config.yaml

Server Config

In the server section of your config file, you can specify the following parameters:

Key	Type	Description
`host`	`string`	The Server Address to bind to (when using `serve`) or connect to (when using the CLI as client). Note: Does not support hot-reloading of the config during runtime. Requires restart.
`httpPort`	`int`	The REST API Port (Default: `8099`). Note: Does not support hot-reloading of the config during runtime. Requires restart.
`grpcPort`	`int`	The gRPC API Port (Default: `50051`). Note: Does not support hot-reloading of the config during runtime. Requires restart.
`debug`	`int`	Enable debug settings (Default: `false`)
`refresh`	`time.Duration`	How often the iCal calendars are refreshed (Default: `30m`)

Example (Server)

server:
  host: ""
  httpPort: 8080
  grpcPort: 50051
  debug: false
  refresh: 5m

Example (Client)

server:
  host: "homeassistant.local"
  debug: false