Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
docs [28-11-2007 21:33] cwacha |
docs [05-03-2020 01:03] (current) cwacha |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Documentation ====== | ====== Documentation ====== | ||
- | {{documentation.png? | + | {{:documentation.png? |
- | ==== Prerequisites / Dependencies ==== | + | ===== Prerequisites / Dependencies |
PHP iAddressbook does only have very little dependencies since I wanted it to work on as many systems as possible. | PHP iAddressbook does only have very little dependencies since I wanted it to work on as many systems as possible. | ||
- | You need: | + | You will need: |
- | * [[http:// | + | * [[http:// |
- | * a database (MySQL or SQLite, [[http:// | + | * a database (MySQL |
* (optional) iconv (if you want to import vcards that are not UTF-8 encoded) | * (optional) iconv (if you want to import vcards that are not UTF-8 encoded) | ||
* (optional) ImageMagick' | * (optional) ImageMagick' | ||
- | ==== Installation ==== | + | ===== Installation |
Installing the address book consists of four steps: | Installing the address book consists of four steps: | ||
- | - create a new database called // | + | - Copy all files to your web space |
- | - create three new tables inside this database called // | + | - Open your web browser |
- | - make a copy of // | + | - Follow the steps in the installer |
- | - if you want authorization support | + | - If you want authorization support |
- | === Setup for SQLite === | ||
- | - make sure that your PHP installation has sqlite support | + | ===== Upgrade ===== |
- | - adjust your // | + | |
- | - either create a new sqlite database or use the one supplied with PHP iAddressBook | + | |
- | - sqlite version 2.x and version 3.x are not compatible, make sure that you are using the correct version (sqlite-db2 is for version 2.x - sqlite-db3 is for version 3.x) | + | |
- | - make sure that the webserver and PHP can write to the sqlite database file (use '' | + | |
- | - make sure that the webserver and PHP can write to the directory where the sqlite database file is located (use '' | + | |
+ | The easiest way to upgrade is to use the vCard export feature to get all your contacts | ||
+ | and then import these contacts into a new installation. You won't lose any data as the | ||
+ | vCard export preserves all fields! | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | === Setup for SQLite | + | Follow these steps and you should be on the safe side: |
- | This assumes that you already | + | - Export all your contacts using the vCard export. |
+ | - Install the addressbook as described in the installation chapter. | ||
+ | - Import your vCard into the new addressbook. Use the //folder import// feature if you | ||
+ | | ||
+ | - If everything works as expected, remove the old installation | ||
+ | new installation to the old place. | ||
- | |||
- | * Make sure that you have all of the other bits and pieces installed: | ||
- | |||
- | # apt-get install libphp-adodb php4-pear php4-sqlite sqlite</ | ||
- | |||
- | * Unzip iAddressbook into your web servers DocumentRoot and rename the folder appropriately: | ||
- | |||
- | # unzip -a ab_095.zip -d /var/www | ||
- | # mv / | ||
- | |||
- | * Change into the iAddressbook directory: | ||
- | |||
- | # cd / | ||
- | |||
- | * Change permissions on the provided sqlite database so that the web server has write permissions (www-data is the default web server user on Debian, if you've changed it to use another user you'll need to change the below command appropriately): | ||
- | |||
- | # chown -R www-data sqlite/ | ||
- | |||
- | * Copy in the new config files you are going to use: | ||
- | |||
- | # cp conf/ | ||
- | # cp conf/ | ||
- | |||
- | * Edit config.php and change it so that it uses the SQLite database, the database section should look something like this (note that the dbname, username and password variables aren't needed for SQLite): | ||
- | |||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | $conf[' | ||
- | |||
- | * You should now be ready to go, you can test your installation by going to the URL (eg. http:// | ||
- | |||
- | |||
- | ==== Upgrade ==== | ||
- | |||
- | Upgrading is always tricky since you have to make sure that no personal configuration data is accidently overridden. I tried to separate the default configuration settings from your personal settings to make updating as easy as possible. The data-format for you contacts in the database is stable (even for upcoming categories). Your contacts will always remain safe in the database and are not affected by an upgrade. There is no need to create a new database if you are upgrading. | ||
- | |||
- | |||
- | Follow these steps and you should be on the safe side: | ||
- | |||
- | - Read the changelog (check for changed database layout or other incompatibilities). | ||
- | - create a parallel installation of the addressbook and copy your old **// | ||
- | - if you have a customized template you will have to migrate it manually. I still have to make minor changes in the default templates. Best bet would be to //diff// the old default template with the new one to see if anything has changed. | ||
- | - if everything works as expected, remove the old installation and rename/move your new installation to the old place. | ||
[[changelog|The changelog can be found here]] | [[changelog|The changelog can be found here]] | ||
- | ==== Import ==== | + | ===== Import |
Import //should// work out of the box as the addressbook can auto-detect the most important encodings. The addressbook can detect vCards in the following encodings: | Import //should// work out of the box as the addressbook can auto-detect the most important encodings. The addressbook can detect vCards in the following encodings: | ||
Line 103: | Line 52: | ||
All UNICODE encodings are auto-detected even if the file does not have a Byte Order Mark (BOM). The last encoding (here: ISO-8859-1) is a fallback encoding if auto-detection does not work (or if the file is not UTF encoded) and can be configured in the configuration file. All encodings supported by **iconv** are available. | All UNICODE encodings are auto-detected even if the file does not have a Byte Order Mark (BOM). The last encoding (here: ISO-8859-1) is a fallback encoding if auto-detection does not work (or if the file is not UTF encoded) and can be configured in the configuration file. All encodings supported by **iconv** are available. | ||
- | === Conversion === | + | ==== Conversion ==== |
You can use a tool like // | You can use a tool like // | ||
Line 114: | Line 64: | ||
iconv -f UTF-16 -t UTF-8 vcard.vcf > converted_vcard.vcf | iconv -f UTF-16 -t UTF-8 vcard.vcf > converted_vcard.vcf | ||
- | ==== Permissions / Access Controls ==== | + | ===== Permissions / Access Controls |
Since version 0.98 the iAddressBook has advanced authentication support. Every logged in user has a set of actions which he is allowed to execute. That way we have complete control over who is allowed to add contacts and who may delete groups or export vCards. If the user is not logged in he can be optionally //mapped// to a guest account. The //guest// permissions can be configured as well. Let's see how it works. | Since version 0.98 the iAddressBook has advanced authentication support. Every logged in user has a set of actions which he is allowed to execute. That way we have complete control over who is allowed to add contacts and who may delete groups or export vCards. If the user is not logged in he can be optionally //mapped// to a guest account. The //guest// permissions can be configured as well. Let's see how it works. | ||
- | === Activate Authentication === | + | ==== Activate Authentication |
* First of all we have to activate authentication support (as long as this is disabled, everyone has full access to the iAddressBook). You can do this in **'' | * First of all we have to activate authentication support (as long as this is disabled, everyone has full access to the iAddressBook). You can do this in **'' | ||
Line 132: | Line 82: | ||
</ | </ | ||
- | === Creating User Accounts === | + | ==== Creating User Accounts |
* Now we have to setup user accounts. As with prior versions they are all managed inside **''/ | * Now we have to setup user accounts. As with prior versions they are all managed inside **''/ | ||
Line 151: | Line 101: | ||
* As the address book already comes with pre-defined groups (@admin, @editor, @guest) you will probably not need the ' | * As the address book already comes with pre-defined groups (@admin, @editor, @guest) you will probably not need the ' | ||
- | === Creating Groups === | + | ==== Creating Groups |
- | * Groups are also maintained within **''/ | + | * Groups are also maintained within **''/ |
<code php> | <code php> | ||
- | $auth[' | + | $auth[' |
' | ' | ||
- | ' | + | ' |
- | ' | + | ' |
- | ' | + | ' |
- | $auth[' | + | |
+ | $auth[' | ||
' | ' | ||
- | ' | + | ' |
- | ' | + | ' |
- | $auth[' | + | |
+ | $auth[' | ||
' | ' | ||
- | ' | + | ' |
- | ' | + | ' |
+ | |||
+ | $auth[' | ||
+ | ' | ||
+ | ' | ||
+ | ' | ||
</ | </ | ||
- | + | ==== Guest Account | |
- | === Guest Account === | + | |
* The guest account is a normal user account an can also be configured like any other user account. The guest username is ' | * The guest account is a normal user account an can also be configured like any other user account. The guest username is ' | ||
Line 188: | Line 144: | ||
</ | </ | ||
- | === Actions Index === | + | ==== Actions Index ==== |
The default action is ' | The default action is ' | ||
Line 220: | Line 176: | ||
| check | Check if the installation of iAddressBook works properly (database, file system access, etc.) | | | check | Check if the installation of iAddressBook works properly (database, file system access, etc.) | | ||
+ | ===== XML-RPC API ===== | ||
+ | [[docs: | ||
- | ==== Contact Format ==== | + | ===== CardDAV Interface ===== |
+ | |||
+ | [[docs: | ||
+ | |||
+ | ===== Contact Format | ||
* title | * title | ||
* firstname | * firstname | ||
Line 249: | Line 211: | ||
* creation date | * creation date | ||
* modification date | * modification date | ||
+ | * UID | ||
- | === Unsupported fields === | + | ==== Unsupported fields |
* maidenname (X-MAIDENNAME) | * maidenname (X-MAIDENNAME) | ||
* custom dates (X-ABDATE) | * custom dates (X-ABDATE) | ||
Line 257: | Line 220: | ||
These fields will not be included since I have absolutely no need for them. The current design is transparent enough for me. | These fields will not be included since I have absolutely no need for them. The current design is transparent enough for me. | ||
- | |||
- | ==== Templates ==== | ||
- | |||
- | This section describes the HTML template that is currently used. In the current state the template system should be flexible enough to allow you to design a look and feel as you like (and not as the template system likes). | ||
- | |||
- | The template files have the file ending '' | ||
- | |||
- | main.tpl | ||
- | | | ||
- | +- search.tpl | ||
- | | | ||
- | +- tpl_showcontactlist() | ||
- | | ||
- | | ||
- | | ||
- | | | ||
- | +- tpl_showperson() | ||
- | +- person_empty.tpl | ||
- | | | ||
- | +- person.tpl | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | | ||
- | +- person_edit.tpl | ||
- | +- tpl_include() | ||
- | | ||
- | | | ||
- | +- tpl_include() | ||
- | | ||
- | | | ||
- | +- tpl_include() | ||
- | | ||
- | | | ||
- | +- tpl_include() | ||
- | | ||
- | | | ||
- | +- tpl_include() | ||
- | | ||
- | | | ||
- | +- tpl_include() | ||
- | +- person_edit_addresses.tpl | ||
- | |||
- | |||
- | |||
- | * // | ||
- | * // | ||
- | |||
- | |||
- | * All other functions work the same way, you should get the hang of it. Remark that **person_edit.tpl** does not call any // | ||
- | ~~DISCUSSION: |