Skip to content

Commit 3abadf0

Browse files
committed
added readme
1 parent 57723bd commit 3abadf0

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# PHP iCAL Viewer
2+
3+
## Parameters
4+
5+
### CALENDAR_LANGUAGE
6+
Which language are the calendar events in?
7+
### CALENDAR_URLS
8+
The `.ics` URLs of your calendars. For multiple entries, input them comma-separated.
9+
### CALENDAR_NAMES
10+
The names for your calendars. For multiple entries, input them comma-separated.
11+
The values have to be in the same order than `CALENDAR_URLS`
12+
### CALENDAR_COLORS
13+
The colors for your calendars. For multiple entries, input them comma-separated.
14+
The values have to be in the same order than `CALENDAR_URLS`
15+
### CALENDAR_PASSWORDS
16+
For protecting access to the calendar, you can define multiple passwords.
17+
When opening the page, a password popup is displayed. The password is stored
18+
for a longer timeframe in a browser cookie. Multiple values can be defined comma-separated.
19+
### CALENDAR_CACHE_TTL
20+
How long should fetched `.ics` files be cached locally, until they are refreshed from
21+
the remote source? Value is in seconds.
22+
### APP_SECRET
23+
A random string used by the Symfony framework.
24+
### CALENDAR_PUBLIC_AVAILABILITY
25+
Normally, when `CALENDAR_PASSWORDS` is set, the calendar can't be accessed by the public.
26+
If you enable this option, a limited view with available / not available times is
27+
shown instead. This way you can communicate availability without leaking details.

0 commit comments

Comments
 (0)