aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/intro.md8
-rw-r--r--doc/setup.md62
2 files changed, 70 insertions, 0 deletions
diff --git a/doc/intro.md b/doc/intro.md
new file mode 100644
index 0000000..f4ee2a2
--- /dev/null
+++ b/doc/intro.md
@@ -0,0 +1,8 @@
+# Overview of calendaring info
+
+[[!template id=realm]] handles personal and group calendars.
+Some calendars are also public readable.
+
+## Setup
+
+ * Short [[event/intro]] to start using calendaring
diff --git a/doc/setup.md b/doc/setup.md
new file mode 100644
index 0000000..7cc535e
--- /dev/null
+++ b/doc/setup.md
@@ -0,0 +1,62 @@
+# Calendaring introduction
+
+Anyone can read calendars shared publicly at [[!template id=realm]].
+
+Your personal [[account]] grants read-only access to closed-group shared calendars.
+
+Custom group accounts provide write access to (closed-group or public) shared calendars.
+
+
+## Clients
+
+Recommended calendaring client depends on the operating system you use:
+
+ * Mac, iPhone and iPad: Apple Calendar
+ * Windows and Linux: [Mozilla Lightning](https://www.mozilla.org/en-US/projects/calendar/)
+ * Android: [DavDroid](https://f-droid.org/app/at.bitfire.davdroid)
+
+
+## Security
+
+Before you setup any password-protected calendars,
+make sure to install the [CACert.org security certificate](http://wiki.cacert.org/FAQ/BrowserClients).
+
+
+## Read-only access
+
+If you only need to read a calendar maintained by others,
+then the best (most efficient) is to subscribe to an "iCal" calender:
+
+ 1. Go to web page http://[[!template id=eventhost]]/
+ 2. Copy address of relevant calendar.
+ 3. Open calendaring client, and add new account profile.
+ 4. Request creation of a new "ical" profile
+ 5. Paste the calendar address as server address.
+
+Closed-group calendars also require username and password,
+and require a secure connection (TLS or SSL, or "https://" address).
+
+
+## Read-write access
+
+To both read a calendar and help maintain its content,
+you need to setup a "CalDAV" profile.
+
+Some calendaring clients (e.g. recent Apple Calendar) need little profile info:
+
+ * Server address: **[[!template id=eventhost]]:8443**
+ * Username and password: Credentials for either your personal account or a custom group account
+
+Some calendaring clients (e.g. older Apple ical) need slightly more profile info:
+
+ * Server address: **https://[[!template id=eventhost]]:8443/calendars/users/**
+ * Username and password: Credentials for either your personal account or a custom group account
+
+Other calendaring clients (e.g. Mozilla Lightning) need exact calendar address:
+
+ 1. Go to web page https://[[!template id=eventhost]]:8443/calendars/users/USERNAME/
+ (replace USERNAME with personal or calendar-group account name)
+ 2. Copy address for relevant calendar (a.k.a. "Collection").
+ 3. Open calendaring client, and add new account profile.
+ 4. Request creation of a new "CalDAV" profile (also called "on the network")
+ 5. Paste the calendar address as server address.