Jérôme Schneider
parent
99f8c6d6c7
commit
622e4a02e1
3 changed files with 68 additions and 89 deletions
|
|
@ -17,13 +17,13 @@ TEMPDIRDEREFERENCE="/tmp/baikal-flat-`date +%Y-%m-%d-%H-%M-%S`"
|
|||
mkdir $TEMPDIR && cd ../../../../ && git archive $BRANCH | tar -x -C $TEMPDIR
|
||||
|
||||
# Dereferencig symlinks
|
||||
cp -Rf --dereference $TEMPDIR $TEMPDIRDEREFERENCE
|
||||
rm -Rf $TEMPDIR
|
||||
cp -RfL $TEMPDIR $TEMPDIRDEREFERENCE && \
|
||||
rm -Rf $TEMPDIR && \
|
||||
|
||||
TEMPDIR=$TEMPDIRDEREFERENCE
|
||||
TEMPDIR=$TEMPDIRDEREFERENCE && \
|
||||
|
||||
# Jump to tempdir
|
||||
cd $TEMPDIR
|
||||
cd $TEMPDIR && \
|
||||
|
||||
# Cleaning git stuff
|
||||
rm .gitignore
|
||||
|
|
@ -47,4 +47,12 @@ rm -Rf Core/Frameworks/Baikal/WWWRoot
|
|||
rm -Rf Core/Frameworks/BaikalAdmin/WWWRoot
|
||||
|
||||
# Cleaning Specific/Virtualhosts
|
||||
rm -Rf Specific/virtualhosts
|
||||
rm -Rf Specific/virtualhosts
|
||||
|
||||
# Moving HTML roots
|
||||
mv html/* .
|
||||
mv html/.htaccess .
|
||||
rm -Rf html
|
||||
|
||||
# Displaying result
|
||||
echo "# "$TEMPDIR
|
||||
121
INSTALL.md
121
INSTALL.md
|
|
@ -1,18 +1,20 @@
|
|||
# INSTALLING Baïkal Server
|
||||
# INSTALLING Baïkal
|
||||
|
||||
This document is a part of the Baïkal Server project. Baïkal Server is an open
|
||||
This document is a part of the Baïkal project. Baïkal is an open
|
||||
source lightweight CalDAV and CardDAV server released under the GNU GPL. Baïkal
|
||||
is copyright (c) 2012 by Jérôme Schneider.
|
||||
|
||||
This document describes the system requirements for Baïkal Server and the
|
||||
Baïkal homepage is http://baikal.codr.fr
|
||||
|
||||
This document describes the system requirements for Baïkal and the
|
||||
installation routine.
|
||||
|
||||
# 1 - System requirements
|
||||
|
||||
Baïkal Server is based on PHP 5.3.0, and uses a SQLite3 with PHP PDO. This
|
||||
Baïkal is based on PHP 5.3.0, and uses a SQLite3 with PHP PDO. This
|
||||
document does not cover the installation of these requirements.
|
||||
|
||||
## 1 - System requirements for FTP-driven hosting
|
||||
## 1.1 - System requirements for FTP-driven hosting
|
||||
|
||||
The following configuration is the minimum required:
|
||||
|
||||
|
|
@ -25,7 +27,7 @@ The following configuration is the minimum required:
|
|||
|
||||
- 30 MB of disk space
|
||||
|
||||
## 2 - System requirements for dedicated server hosting
|
||||
## 1.2 - System requirements for dedicated server hosting
|
||||
|
||||
The following configuration is the minimum required:
|
||||
|
||||
|
|
@ -47,31 +49,46 @@ The following configuration is the minimum required:
|
|||
|
||||
- Apache configuration that activates "FollowSymlinks"
|
||||
|
||||
# 1 - Obtaining Baïkal Server
|
||||
# 2 - Obtaining Baïkal
|
||||
|
||||
To get Baïkal Server, navigate to the following location:
|
||||
To get Baïkal, navigate to the following location:
|
||||
http://baikal.codr.fr/
|
||||
|
||||
# 2 - Installation > Installing files
|
||||
# 3 - Installation
|
||||
|
||||
To install Baïkal Server, unpack the source package outside of the web site root
|
||||
## 3.1 - Installing Baïkal on a FTP-driven hosting
|
||||
|
||||
To install Baïkal on a FTP-driven hosting:
|
||||
* Download the "Baikal package for installation via FTP"
|
||||
* Unzip the package on you computer
|
||||
* Send the unzipped package on the remote host via FTP
|
||||
* (optional) Rename the Baïkal folder to whatever you want
|
||||
* Navigate to the HTTP URL where you just uploaded Baïkal
|
||||
* Follow the instructions of the initialization web tool
|
||||
|
||||
## 3.2 - Installing Baïkal on a dedicated host
|
||||
|
||||
### 3.2.1 - Unpacking files
|
||||
|
||||
To install Baïkal on a dedicated host, download the "Baïkal package".
|
||||
Unpack the source package outside of the web site root
|
||||
directory on your server. The location must be accessible to the web server.
|
||||
Usually, it will be something like /var/www/
|
||||
|
||||
# a. Enter the directory where the websites are stored
|
||||
$ root:~> cd /var/www
|
||||
|
||||
Unpacking will produce a directory with a name like BaikalServer-x.y.z, where x,
|
||||
y and z correspond to the Baïkal Server version. For example, the Baikal Server
|
||||
0.0.1 source package will create a directory named BaikalServer-0.0.1.
|
||||
Unpacking will produce a directory with a name like baikal-x.y.z, where x.y.z
|
||||
correspond to the Baïkal version. For example, the Baïkal 0.2.0 source package
|
||||
will create a directory named baikal-0.2.0
|
||||
|
||||
# b. Unpack the package using:
|
||||
$ root:/var/www> tar xzf BaikalServer-0.0.1.tgz
|
||||
$ root:/var/www> tar xzf baikal-0.2.0.tgz
|
||||
|
||||
Rename the untar'd directory to the name of your baikal dedicated subdomain.
|
||||
|
||||
# c. Rename the directory to match your domain (good practice)
|
||||
$ root:/var/www> mv BaikalServer-0.0.1 dav.mydomain.com
|
||||
$ root:/var/www> mv baikal-0.2.0 dav.mydomain.com
|
||||
|
||||
# d. Enter the new Baïkal directory
|
||||
$ root:/var/www> cd dav.mydomain.com
|
||||
|
|
@ -84,9 +101,9 @@ running Apache is www-data:www-data
|
|||
# e. Change permissions on the files
|
||||
$ root:/var/www/dav.mydomain.com> chown www-data:www-data . -Rf
|
||||
|
||||
# 3 - Installation > Installing virtualhost
|
||||
### 3.2.2 - Setting up the Apache virtualhost
|
||||
|
||||
Baïkal Server must be bound to a domain/subdomain in order to run properly.
|
||||
Baïkal must be bound to a domain/subdomain in order to run properly.
|
||||
This package provides a default virtualhost configuration file for Apache 2 in
|
||||
Specific/virtualhosts/baikal.apache2
|
||||
|
||||
|
|
@ -117,77 +134,30 @@ In our example, we will assume that the apache2 configuration directory is:
|
|||
# h. Restart apache
|
||||
$ root:/etc/apache2/sites-enabled> /etc/init.d/apache2 restart
|
||||
|
||||
# 4 - Installation > Setting up Baïkal Server
|
||||
### 3.2.3 - Setting up Baïkal
|
||||
|
||||
To set up Baïkal Server, you have to modify the content of the file
|
||||
Specific/config.php
|
||||
In a web browser, navigate to http://dav.mydomain.com and follow the instructions of the initialization web tool
|
||||
|
||||
There are 2 configurations you have to configure:
|
||||
# 4 - Connecting your CalDAV / CardDAV client to Baïkal
|
||||
|
||||
# Timezone of your users; If unsure check http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
define("BAIKAL_TIMEZONE", "Europe/Paris");
|
||||
## 4.1 - Apple iCal:
|
||||
|
||||
# WEB absolute URI
|
||||
define("BAIKAL_BASEURI", "http://dav.mydomain.com/");
|
||||
|
||||
# 5 - Checking that Baïkal is properly configured
|
||||
|
||||
You may now navigate to your domain URL using your favorite web browser. You should see something like:
|
||||
|
||||
No users are defined.
|
||||
To create a user, you can use the helper Core/Scripts/adduser.php (requires command line access)
|
||||
|
||||
If not, there's a problem somewhere. Take a deep breath, and try to understand
|
||||
what's going on. Checking out the apache log might also
|
||||
be useful (tail -f /var/log/apache2/error.log)
|
||||
|
||||
# 6 - Installation > Creating your first user
|
||||
|
||||
Baïkal won't run before you create at least one user.
|
||||
To do so, run the script Core/Scripts/adduser.php like this (replace username
|
||||
with the actual username):
|
||||
|
||||
# Enter the Baïkal Scripts directory
|
||||
$ root:/etc/apache2/sites-enabled> cd /var/www/dav.mydomain.com/Core/Scripts/
|
||||
|
||||
# Add a user
|
||||
$ root:/var/www/dav.mydomain.com/Core/Scripts> ./adduser.php username
|
||||
|
||||
And follow the instructions on screen.
|
||||
|
||||
If something like this shows up: "-bash: ./adduser.php: Permission denied"
|
||||
You'll have to add the execution right to the script before running it:
|
||||
chmod +x ./adduser.php
|
||||
|
||||
Note: there's also a moduser.php script that'll allow you to modify users.
|
||||
|
||||
# 7 - Checking that Baïkal is ready to swim
|
||||
|
||||
You may now navigate to your domain URL using your favorite web browser. You should see something like:
|
||||
|
||||
Baïkal on http://dav.mydomain.com/
|
||||
|
||||
In not, there's a problem somewhere. Take a deep breath, and try to understand
|
||||
what's going on. Checking out the apache log might also
|
||||
be useful (tail -f /var/log/apache2/error.log)
|
||||
|
||||
# 8 - Connecting your CalDAV / CardDAV client to Baïkal Server
|
||||
|
||||
## Apple iCal:
|
||||
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
|
||||
|
||||
## Apple Address Book:
|
||||
## 4.2 - Apple Address Book:
|
||||
|
||||
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
|
||||
|
||||
## Thunderbird/Lighning:
|
||||
## 4.3 - Thunderbird/Lighning:
|
||||
|
||||
Add a new CalDAV account:
|
||||
|
||||
* Navigate to "Lightning" > "New account" > "On the network" > "URL"
|
||||
|
|
@ -195,7 +165,7 @@ Add a new CalDAV account:
|
|||
of and replace the domain name, and the username with the correct values
|
||||
* When asked, provide user/password; your CalDAV account should be up and running
|
||||
|
||||
# 9 - You're done
|
||||
# 5 - You're done
|
||||
|
||||
You may now create new calendars, new events, new visit cards :) Enjoy.
|
||||
|
||||
|
|
@ -206,8 +176,9 @@ me after reading README.md
|
|||
|
||||
# 11 - FAQ
|
||||
|
||||
Q: Why is the Baïkal logo a fish ?
|
||||
A: The fish is an Omul. According to Wikipedia
|
||||
Q: Why is the Baïkal logo a fish ?
|
||||
|
||||
A:The fish is an Omul. According to Wikipedia
|
||||
(http://en.wikipedia.org/wiki/Omul): The omul, Coregonus migratorius, also
|
||||
known as Baikal omul (Russian: байкальский омуль), is a whitefish species
|
||||
of the salmon family endemic to Lake Baikal in Siberia, Russia. It is
|
||||
|
|
|
|||
18
README.md
18
README.md
|
|
@ -1,27 +1,27 @@
|
|||
# 1. About this package
|
||||
|
||||
This package contains a release of Baïkal Server.
|
||||
This package contains a release of Baïkal.
|
||||
Go to http://baikal.codr.fr to get more information about this package, and upgrades.
|
||||
|
||||
# 2. What is Baïkal Server ?
|
||||
# 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
|
||||
Server is distributed under the GPL license.
|
||||
is distributed under the GPL license.
|
||||
|
||||
To get more info about the GPL license, visit
|
||||
http://www.opensource.org/licenses/gpl-license.php.
|
||||
|
||||
# 3. Baïkal Server requirements
|
||||
# 3. Baïkal requirements
|
||||
|
||||
Baïkal Server is based on PHP 5.3.0, and uses a SQLite3 with PHP PDO. For more
|
||||
Baïkal is based on PHP 5.3.0, and uses a SQLite3 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 Server
|
||||
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...
|
||||
|
|
@ -29,13 +29,13 @@ information regarding these requirements see the INSTALL.md file in this folder.
|
|||
server environment (phpinfo())...
|
||||
- Be as specific and clear as possible - questions like "my
|
||||
installation does not work - what can I do???" will be ignored.
|
||||
- I can read english and french.
|
||||
- Write in english or french, please.
|
||||
|
||||
4. If you have identified a genuine new bug report it at
|
||||
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 get started
|
||||
|
||||
Please see the INSTALL.md in this folder.
|
||||
|
||||
-- Jérôme Schneider <mail@jeromeschneider.fr> Wed, 22 Feb 2012 21:46:00 +0100
|
||||
-- Jérôme Schneider <mail@jeromeschneider.fr> Sat, 12 May 2012 23:45:00 +0100
|
||||
Loading…
Reference in a new issue