jdejaegh/ics-fusion
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme and the config sample to add the cache setting

Browse source
This commit is contained in:
Jules 2020-11-03 21:59:01 +01:00
parent dff7b57c79
commit a6d4b3b113
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -17,6 +17,7 @@ The JSON configuration file should look like the following.
{ {
"url":"str", "url":"str",
"name":"str", "name":"str",
"cache": 10,
"encoding":"str", "encoding":"str",
"filters":{ "filters":{
"name":{ "name":{
@ -60,16 +61,17 @@ The JSON configuration file should look like the following.
Only the `url` and the `name` field are mandatory. Only the `url` and the `name` field are mandatory.
- `url`: specify the url to find the calendar - `url`: specify the url to find the calendar
- `name`: name to identify the calendar - `name`: name to identify the calendar
- `cache`: if present cache the remote calendar according to the interval set in minutes
- `encoding`: specify the encoding to use - `encoding`: specify the encoding to use
- `filters`: structure defining the filters to apply to the calendar - `filters`: structure defining the filters to apply to the calendar
- `name`: filters to apply to the name field of the events - `name`: filters to apply to the name field of the events
- `description`: filters to apply to the name field of the events - `description`: filters to apply to the name field of the events
- `exclude`: RegEx to describe the events to exclude - cannot be specified with includeOnly - `exclude`: RegEx to describe the events to exclude - cannot be specified with includeOnly
- `includeOnly`: RegEx to describe the events to include - cannot be specified with exclude - `includeOnly`: RegEx to describe the events to include - cannot be specified with exclude
- `ignoreCase`: if true the RegEx will ignore the case of the field - `ignoreCase`: if true the RegEx will ignore the case of the field
- `modify`: structure defining the modifications to the events of the calendar - `modify`: structure defining the modifications to the events of the calendar
- `time`: describe the modifications to apply to the timing of the event - `time`: describe the modifications to apply to the timing of the event
@ -80,11 +82,11 @@ Only the `url` and the `name` field are mandatory.
- `location`: modification to apply to the location of the events - `location`: modification to apply to the location of the events
- `addPrefix`: string to add at the beginning of the field - `addPrefix`: string to add at the beginning of the field
- `addSuffix`: string to add at the end of the field - `addSuffix`: string to add at the end of the field
If multiple calendars are specified in the configuration list, their events will be merged in the resulting ics feed. If multiple calendars are specified in the configuration list, their events will be merged in the resulting ics feed.
## Usage ## Usage
Once the config file is created, the corresponding HTTP endpoint is accessible. For example, if the file `app/config/my-calendar.json` contains the configuration, the HTTP endpoint will be `http://localhost:8088/my-calendar`. Once the config file is created, the corresponding HTTP endpoint is accessible. For example, if the file `app/config/my-calendar.json` contains the configuration, the HTTP endpoint will be `http://localhost:8088/my-calendar`.
## Limitations ## Limitations
Currently, the application only merges events of the ics feeds, the alarms and todos are not supported. There is no mechanism to handle the case where an incoming feed becomes unavailable. Currently, the application only merges events of the ics feeds, the alarms and todos are not supported.

1
config-sample.txt
View file

@ -1,6 +1,7 @@
[ [
{"url": "str", {"url": "str",
"name": "str", "name": "str",
"cache": 10,
"encoding": "str", "encoding": "str",
"filters": { "filters": {
"name": {"exclude": "RegEx", "includeOnly": "RegEx", "ignoreCase": true}, "name": {"exclude": "RegEx", "includeOnly": "RegEx", "ignoreCase": true},