0% found this document useful (0 votes)
120 views6 pages

Addressbook User Manual v0.4 Guide

This document provides instructions for installing and configuring an addressbook application. It discusses: - Quick and manual installation steps including downloading files, extracting SQL, configuring database details, and validating installation. - Configuring users and passwords by editing configuration files to add users with different roles like root, editor, and readonly access as well as IP ranges. - Additional integrations like setting up email providers for mailing, enabling iPhone/Android synchronization using ActiveSync, and future integrations with Facebook, Twitter and Google. - Customizing the look and feel by disabling Google Maps and changing the number of rows displayed on index pages.

Uploaded by

lancy_dsuza
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
120 views6 pages

Addressbook User Manual v0.4 Guide

This document provides instructions for installing and configuring an addressbook application. It discusses: - Quick and manual installation steps including downloading files, extracting SQL, configuring database details, and validating installation. - Configuring users and passwords by editing configuration files to add users with different roles like root, editor, and readonly access as well as IP ranges. - Additional integrations like setting up email providers for mailing, enabling iPhone/Android synchronization using ActiveSync, and future integrations with Facebook, Twitter and Google. - Customizing the look and feel by disabling Google Maps and changing the number of rows displayed on index pages.

Uploaded by

lancy_dsuza
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

User Manual v0.

1
2

TABLE OF CONTENT
Install your addressbook ................................................................................................................................ 2
2.1

Quick installation ................................................................................................................................... 2

2.2

Manual installation ................................................................................................................................ 2

2.3

Setup user and passwords ..................................................................................................................... 2

2.3.1

Setup User with passwords ............................................................................................................... 2

2.3.2

Setup read only users ........................................................................................................................ 2

2.3.1

Setup single users .............................................................................................................................. 2

2.3.2

Setup read-only IP-Ranges ................................................................................................................ 3

2.3.3

Setup users in database .................................................................................................................... 3

2.4
2.4.1

Yahoo-, Gmail-, hotmail for mailing .................................................................................................. 3

2.4.2

iPhone / Android synchronization ..................................................................................................... 3

2.4.3

Facebook / Twitter / Google integration ........................................................................................... 4

2.5

Look & feel changes ............................................................................................................................... 4

2.5.1

Disable Google-Maps ........................................................................................................................ 4

2.5.2

Rows displayed on [Link] ...................................................................................................... 4

Upgrade your installation ............................................................................................................................... 4


3.1

Additionnal integrations ........................................................................................................................ 3

Fix your language ................................................................................................................................... 4

Improve the addressbook .............................................................................................................................. 5


4.1

Fix your language ................................................................................................................................... 5

4.2

Fix your address guess ........................................................................................................................... 5

4.3

Fix your layout ....................................................................................................................................... 5

4.4

Develop your features ........................................................................................................................... 5

Access your addresses .................................................................................................................................... 6


5.1

Over the web ......................................................................................................................................... 6

5.2

Over the mobile phone .......................................................................................................................... 6

5.2.1

iPhone ............................................................................................................................................... 6

5.2.2

Android .............................................................................................................................................. 6

5.3

Over the database interface .................................................................................................................. 6

5.4

Over e-Mail ............................................................................................................................................ 6

Manage your addresses ................................................................................................................................. 6


6.1

Search an address .................................................................................................................................. 6

6.2

Add an address ...................................................................................................................................... 6

6.2.1

With the web interface ..................................................................................................................... 6

6.2.2

With the E-Mail interface .................................................................................................................. 6

6.2.3

With your mobile phone ................................................................................................................... 6


page 1/ 6

6.3

Edit an address ...................................................................................................................................... 6

6.4

Import / Export addresses ..................................................................................................................... 6

INSTALL YOUR ADDRESSBOOK


2.1 QUICK INSTALLATION
1)
2)
3)
4)
5)

Be sure your server has PHP >=5 installed (4.x is not supported any more).
Download from sourceforge: [Link]
Upload all files to your website, e.g. to [Link]/addressbook
Call your website, e.g. to [Link]/addressbook
Enter your database details.

Have a lot of fun (start with the admin/secret login).

2.2 MANUAL INSTALLATION


6) Be sure your server has PHP >=5 installed (4.x is not supported any more).
7) Download from sourceforge: [Link]
2a) Extract [Link]
2b) Apply to your database (e.g. with phpmyadmin)
3a) Upload all files to your website, e.g. to [Link]/addressbook
3b) Edit the config/[Link] according to your providers information.
$dbname
$dbserver
$dbuser

= "test";
= "localhost";
= "root";

$dbpass

= "";

4) Validate your installation with [Link] , e.g. to [Link]/addressbook/[Link].


5) Change the user setup according to the next chapter.

2.3 SETUP USER AND PASSWORDS


2.3.1 SETUP USER WITH PASSWORDS
1) Edit config/[Link]
2) Add yourself as a root user
$userlist['admin']['pass'] = "secret";
$userlist['admin']['role'] = "root"; // used to call "/[Link]"

3) Add another user (with read/write access)


$userlist['somebody']['pass'] = "secret-too";

2.3.2 SETUP READ ONLY USERS


A readonly user view using role readonly assigned.
$userlist['view']['pass'] = "secret-light";
$userlist['view']['role'] = "readonly";

2.3.1 SETUP SINGLE USERS


page 2/ 6

4) Allow the user view only to access mygroup


$userlist['view']['pass']
$userlist['view']['role']

= "secret-light";
= "readonly";

$userlist['view']['group'] = "mygroup";

2.3.2 SETUP READ-ONLY IP-RANGES


1) Edit config/[Link]
2) Add your companys IP-range (or Proxy IP-addresses) as editors
$iplist['169.168.1.*']['role']

= "editor";

3) OR just add your company read only


$iplist['169.168.1.*']['role']

= "readonly";

2.3.3 SETUP USERS IN DATABASE


You may manage your users in the database too, just uncomment the usertable line:
$usertable = 'user';

Notice : This is not an officially supported feature, as there are not yet any tools available. If you use it, just
dont forget to encode the password mit MD5.
First example, Add a user tot he domain 0:
INSERT INTO user(domain_id, username, md5_pass) VALUES(0, 'myuser', md5('hissecret'));

Second example, give every new user a new domain :


INSERT INTO addr_user(domain_id, username, md5_pass)
SELECT max(domain_id)+1 domain_id
, 'myuser'
, md5('hissecret')

username
md5_pass

from user;

2.4 ADDITIONNAL INTEGRATIONS


2.4.1 YAHOO-, GMAIL-, HOTMAIL FOR MAILING
By default mail is sent over an mailto : call, usually opening your Default Mail client, e.g. Outlook. You may
prefer another client.
1) Edit config/[Link]
2) Uncomment your prefered mail provider.
// $webmail_provider = "gmail";
// $webmail_provider = "yahoo";
// $webmail_provider = "hotmail";

2.4.2 IPHONE / ANDROID SYNCHRONIZATION


Keeping the mobile phone and the addressbook in sync is invaluable, as you will never again forget a copy
paste in any direction.
1.
2.

Unzip [Link] to z-push


Add this to your .htaccess especially the last line !!

Options +FollowSymlinks
RewriteEngine on
RewriteBase /

page 3/ 6

RewriteRule .* - [E=HTTP_MS_ASPROTOCOLVERSION:%{HTTP:Ms-Asprotocolversion}]
RewriteRule .* - [E=HTTP_X_MS_POLICYKEY:%{HTTP:X-Ms-Policykey}]
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
RewriteRule ^Microsoft-Server-ActiveSync(.*)$ addressbook/z-push/[Link]?%{QUERY_STRING}

3.

Check if everything installed by calling this URL :


Fehler! Hyperlink-Referenz ungltig.
4. You will be asked for a vaild user and password.
tbd
5.

A screen looking like this should appear, if everything looks ok:

tbd

2.4.3 FACEBOOK / TWITTER / GOOGLE INTEGRATION


Tbd, coming soon.

2.5 LOOK & FEEL CHANGES


2.5.1 DISABLE GOOGLE-MAPS
You may for security reasons disable Google-Maps, as all addresses are geocoded once at Google :
// $google_maps_keys[''] = "";

2.5.2 ROWS DISPLAYED ON [Link]


You may display other columns :
$disp_cols
= array( "select"
, "photo"
, "last_first"
// , "lastname"
// , "firstname"
, "address"
, "all_emails"
// , "email"
, "all_phones"
// , "telephone"
// , "home"
// , "mobile"
// , "work"
// , "fax"
, "edit"
, "details"
);

UPGRADE YOUR INSTALLATION


3.1 FIX YOUR LANGUAGE
1) Download the latest version from sourceforge: [Link]
2a) Backup or Rename your old addressbook :
o Rename the directory, e.g. from addressbook to [Link]
o OR Download the current directory to your PC

page 4/ 6

o OR Create a .zip with compress addressbook


2b) Backup your database with a full dump/export or at least with this command.
create table addressbook_backup as select * from addressbook ;

3a) Extract the /_upgrades directory on your PC


3b) Apply all patches greater your old version to the database (e.g. with phpmyadmin)
4a) Upload all files to your website, e.g. to [Link]/addressbook
4b) Copy the old config to the new config.
$dbname
$dbserver

= "test";
= "localhost";

$dbuser

= "root";

$dbpass

= "";

5) Enjoy if it works, revert using first the file backup to your old version and post all bugs.

IMPROVE THE ADDRESSBOOK


4.1 FIX YOUR LANGUAGE

Got to the include directory and search your [Link]. If you have any questions, feel free to post
it to the forum.

4.2 FIX YOUR ADDRESS GUESS


tbd

4.3 FIX YOUR LAYOUT


tbd

4.4 DEVELOP YOUR FEATURES


If you have any good contribution, feel free to post it to the forum.
-

Fork from GitHub: [Link]

page 5/ 6

ACCESS YOUR ADDRESSES


5.1 OVER THE WEB

tbd

5.2 OVER THE MOBILE PHONE

e-Mail : <any@[Link]>
Server : <[Link]>
Domain : [empty]
User : same as web access
Password: same as web access
SSL : Depending on your server configurtation

5.2.1 IPHONE
Setup account => Mail => Exchange => <[Link]> (Disable SSL not available)
[Link]

5.2.2 ANDROID
[Link]

5.3 OVER THE DATABASE INTERFACE


Vw_addressbook
Vw_addressbook_deleted

5.4 OVER E-MAIL


tbd, coming soon

MANAGE YOUR ADDRESSES


6.1 SEARCH AN ADDRESS

Just type the name or address in the field on the first page.
Select the group concerned, if you know wish to select people out of a group.

6.2 ADD AN ADDRESS


6.2.1 WITH THE WEB INTERFACE
tbd

6.2.2 WITH THE E-MAIL INTERFACE


Tbd, coming soon

6.2.3 WITH YOUR MOBILE PHONE


Install the ActiveSync support as described in chapter xxx.

6.3 EDIT AN ADDRESS


With the web interface
With your mobile phone

6.4 IMPORT / EXPORT ADDRESSES

page 6/ 6

You might also like