forks/baikal
1
0
Fork 0
Code Releases Activity

Simplified the README, removed UPGRADE

Browse source
This commit is contained in:
Evert Pot 2016-01-28 18:39:41 -05:00
parent 2487da4406
commit 03ea870f80
2 changed files with 14 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,51 +1,19 @@
# 1. About this package
Baïkal
======
This package contains a release of Baïkal.
Go to http://baikal-server.com to get more information about this package, and upgrades.
This is the source repository for the Baïkal CalDAV and CardDAV server.
# 2. What is Baïkal ?
* Go to [baikal-server.com][1] to get more information about this project.
* Head to [sabre.io/baikal][2] for information about installation, upgrading
and troubleshooting.
Baïkal is an open source lightweight CalDAV and CardDAV server. It's developped
by Jérôme Schneider and based on the excellent [SabreDAV](http://code.google.com/p/sabredav/ "SabreDAV") project.
Baïkal is distributed under the GPL license.
Credits
-------
To get more info about the GPL license, visit
http://www.opensource.org/licenses/gpl-license.php.
Bäikal is developed by [Jérôme Schneider][3] from [Net Gusto][3] and [fruux][4].
Many thanks to Daniel Aleksandersen (@zcode) for greatly improving the quality of the project page (http://baikal-server.com).
# 3. Baïkal requirements
Baïkal is based on PHP 5.3.1+, and uses a SQLite3 or MySQL with PHP PDO. For more
information regarding these requirements see the INSTALL.md file in this folder.
# 4. What should you do if you have a problem ?
1. Read the available documentation carefully
2. Search the web carefully about Baïkal CalDAV CardDAV
3. If you have identified a genuine new bug,
report it at https://github.com/jeromeschneider/Baikal/issues
# 5. How to install / configure Baïkal
Please read INSTALL.md in this folder.
# 6. How to configure my CalDAV / CardDAV client ?
Please read INSTALL.md in this folder.
# 7. How to upgrade my Baïkal server to a new version ?
Please read UPGRADE.md in this folder.
# 8. Troubleshooting
Please read TROUBLESHOOTING.md in this folder.
# 9. Credits
Baïkal is developed by Jérôme Schneider.
Jérôme Schneider (@jeromeschneider) is admin and lead developer.
Many thanks to Daniel Aleksandersen (@zcode) for greatly improving the quality of the project page (http://baikal-server.com). Much appreciated, Daniel :)
-- Jérôme Schneider <mail@jeromeschneider.fr> Mon, 21 Aug 2012 12:17:00 +0100
[1]: http://baikal-server.com/
[2]: http://sabre.io/baikal/
[3]: http://netgusto.com/
[4]: https://fruux.com/

16
UPGRADE.md
View file

@ -1,16 +0,0 @@
This document explains how to upgrade your Baïkal installation
## Upgrading Baïkal
1. First thing, if you are using MySQL, backup your database. If you are using SQLite, your db file is in the `Specific` folder, backup this folder.
2. Rename your Baïkal root folder. For example from `/var/baikal` to `/var/baikal-old`
3. Download and unzip baïkal to exact folder of your old installation: `/var/baikal` in our example.
4. Replace the folder `baikal/Specific` (the new one) by `baikal-old/Specific` (the old one) (even for MySQL)
5. If working on SSH, apply correct ownership/permissions to files.
1. For the ownership, you can refer to the old installation `baikal-old`. Use `ls -l baikal-old/` command to see the ownership (for example `root:www-data`), and then set them with `sudo chown -Rf root:www-data baikal`
2. For the permissions, you can execute the following command: `sudo chmod -Rf 770 baikal`
6. Using your browser, navigate to your baikal admin, the Upgrade wizard should start.
## Troubleshooting
See TROUBLESHOOTING.md