Updating INSTALL and README, and added a TROUBLESHOOTING.md file

This commit is contained in:
Jérôme Schneider 2012-07-23 08:44:27 +02:00
parent d7fe52ecc1
commit fad183dfb4
2 changed files with 15 additions and 30 deletions

View file

@ -152,7 +152,7 @@ Add a new CalDAV account:
* username: the username you just created (in our example, jerome)
* password: the password you just defined
* In server address: http://dav.mydomain.com/cal.php/principals/jerome
* In server address (replace domain and username): http://dav.mydomain.com/cal.php/principals/jerome
## 5.2 - Apple Calendar (iOS):
@ -170,7 +170,7 @@ Add a new CardDAV account:
* username: the username you just created (in our example, jerome)
* password: the password you just defined
* In server address: http://dav.mydomain.com/card.php/addressbooks/jerome/default
* In server address (replace domain and username): http://dav.mydomain.com/card.php/addressbooks/jerome/default
## 5.4 - Apple Contacts (iOS):
@ -197,5 +197,4 @@ You may now create new calendars, new events, new visit cards :) Enjoy.
# 7 - Troubleshooting
For troubleshooting read the FAQ below. If your problem is not listed, contact
me after reading README.md
Please read TROUBLESHOOTING.md in this folder.

View file

@ -6,7 +6,7 @@ Go to http://baikal.codr.fr to get more information about this package, and upgr
# 2. What is Baïkal ?
Baïkal is an open source lightweight CalDAV and CardDAV server. It's developped
by Jérôme Schneider (http://codr.fr) and based on the SabreDAV library. Baïkal
by Jérôme Schneider (http://jerome.io) and based on the SabreDAV library. Baïkal
is distributed under the GPL license.
To get more info about the GPL license, visit
@ -23,37 +23,23 @@ information regarding these requirements see the INSTALL.md file in this folder.
2. Search the web carefully about Baïkal CalDAV CardDAV
3. Mail me (Jérôme Schneider) at mail@jeromeschneider.fr
When mailing, see the following guidelines...
- Be verbose; Always include the version of used Baïkal and
server environment (phpinfo())...
- Be as specific and clear as possible - questions like "my
installation does not work - what can I do???" will be ignored.
- Write in english or french, please.
3. If you have identified a genuine new bug,
report it at https://github.com/jeromeschneider/Baikal/issues
4. If you have identified a genuine new bug, report it at
the mail address given in point 3 of this list
# 5. How to install / configure Baïkal
# 5. How to get started
Please read INSTALL.md in this folder.
Please see the INSTALL.md in this folder.
# 6. How to configure my CalDAV / CardDAV client ?
# 6. Troubleshooting
Please read INSTALL.md in this folder.
## Problem with Cal/CardDAV auth
On webservers where PHP is served as FastCGI (check your phpinfo()
to find out if that's the case for you), Apache does not pass HTTP
Auth informations to PHP, and thus preventing Cal/CardDAV to auth
requests properly.
Baïkal tries to address this issue by re-routing HTTP Auth informations
using Apaches mod_rewrite. This is done by the Apache config directives
found in the /.htaccess file that comes with Baïkal (or /html/.htaccess
for the non-ftp package).
Note: if this file is empty / does not exist, you should try to add it manually
(sometimes FTP clients decide to not send files with names beginning with a dot ".")
# 7. Troubleshooting
# 7. Credits
Please read TROUBLESHOOTING.md in this folder.
# 8. Credits
Jérôme Schneider (@jeromeschneider) is admin and lead developper.
Many thanks to Daniel Aleksandersen (@zcode) for greatly improving the quality of the project page (http://baikal.codr.fr). Much appreciated, Daniel :)
-- Jérôme Schneider <mail@jeromeschneider.fr> Sat, 12 May 2012 23:45:00 +0100
-- Jérôme Schneider <mail@jeromeschneider.fr> Mon, 23 Jul 2012 08:26:00 +0100