pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[ADD] caldav : documentation for synchronization

Browse Source 
bzr revid: tfr@openerp.com-20110107103824-vmo8eknw94isxjor
This commit is contained in:
Thibault Francois
2011-01-07 11:38:24 +01:00
parent 56678d7d13
commit ee92af9ef7
6 changed files with 1797 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/caldav/doc/all.rst
+41
View File
@@ -0,0 +1,41 @@
==========================
CalDAV How-To
==========================
OpenERP server Setup
--------------------
Some modules need to be installed at the OpenERP server. These are:
- caldav: Required, has the reference setup and the necessary
underlying code. Will also cause document, document_webdav
to be installed.
- crm_caldav: Optional, will export the CRM Meetings as a calendar.
- project_caldav: Optional, will export project tasks as calendar.
- http_well_known: Optional, experimental. Will ease bootstrapping,
but only when a DNS srv record is also used.
These will also install a reference setup of the folders, ready to go.
The administrator of OpenERP can add more calendars and structure, if
needed.
DNS server setup
------------------
To be documented.
SSL setup
----------
It is highly advisable that you also setup SSL to work for the OpenERP
server. HTTPS is a server-wide feature in OpenERP, which means a
certificate will be set at the openerp-server.conf and will be the same
for XML-RPC, HTTP, WebDAV and CalDAV.
The iPhone also supports secure connections with SSL, although it does
not expect a self-signed certificate (or one that is not verified by
one of the "big" certificate authorities [1] ).
[1] I remember one guy that made *lots* of money selling his CA business
off, and since then uses this money to create a software monopoly.
addons/caldav/doc/caldav_doc.pdf
+1638
View File
File diff suppressed because it is too large Load Diff
addons/caldav/doc/evolution.rst
+21
View File
@@ -0,0 +1,21 @@
=========================================
Synchronization with Evolution's calendar
=========================================
1. Go to Calendar View
2. File -> New -> Calendar
3. Fill the form
- type : CalDav
- name : Whaterver you want (ie : Meeting)
- url : http://HOST:PORT/webdav/DB_NAME/calendars/users/USER/c/Meetings (ie :
http://localhost:8069/webdav/db_1/calendars/users/demo/c/Meetings)
the one given on the top of this window
- uncheck "User SSL"
- Username : Your username (ie : Demo)
- Refresh : everytime you want that evolution synchronize the data with the server
4. Click ok and give your openerp password
5. A new calendar named with the name you gave should appear on the left side.
addons/caldav/doc/iPhone.rst
+60 -20
View File
@@ -11,6 +11,34 @@ that data to calendar clients. That said, the full features that would be
accessible through the Gtk or Web OpenERP clients cannot be crammed into
the Calendar clients (such as the iPhone).
OpenERP server Setup
--------------------
Some modules need to be installed at the OpenERP server. These are:
- caldav: Required, has the reference setup and the necessary
underlying code. Will also cause document, document_webdav
to be installed.
- crm_caldav: Optional, will export the CRM Meetings as a calendar.
- project_caldav: Optional, will export project tasks as calendar.
- http_well_known: Optional, experimental. Will ease bootstrapping,
but only when a DNS srv record is also used.
These will also install a reference setup of the folders, ready to go.
The administrator of OpenERP can add more calendars and structure, if
needed.
DNS server setup
------------------
To be documented.
SSL setup
----------
It is highly advisable that you also setup SSL to work for the OpenERP
server. HTTPS is a server-wide feature in OpenERP, which means a
certificate will be set at the openerp-server.conf and will be the same
for XML-RPC, HTTP, WebDAV and CalDAV.
The iPhone also supports secure connections with SSL, although it does
not expect a self-signed certificate (or one that is not verified by
one of the "big" certificate authorities [1] ).
Phone setup
-------------
@@ -18,51 +46,63 @@ The iPhone is fairly easy to setup.
IF you need SSL (and your certificate is not a verified one, as usual),
then you first will need to let the iPhone trust that. Follow these
steps:
s1. Open Safari and enter the https location of the OpenERP server:
s1. Open Safari and enter the https location of the OpenERP server:
https://my.server.ip:8071/
(assuming you have the server at "my.server.ip" and the HTTPS port
is the default 8071)
s2. Safari will try to connect and issue a warning about the certificate
s2. Safari will try to connect and issue a warning about the certificate
used. Inspect the certificate and click "Accept" so that iPhone
now trusts it.
Now, to setup the calendars, you need to:
1. Click on the "Settings" and go to the "Mail, Contacts, Calendars" page.
2. Go to "Add account..."
3. Click on "Other"
4. From the "Calendars" group, select "Add CalDAV Account"
5. Enter the server's name or IP address at the "Server" entry, the
OpenERP username and password at the next ones.
As a description, you can either leave the server's name or
something like "OpenERP calendars".
OpenERP username and password at the next ones.
As a description, you can either leave the server's name or
something like "OpenERP calendars".
6. You _will_ get the "Unable to verify account" error message. That is
because our server is not at the port iPhone expects[2]. But no
need to worry, click OK.
because our server is not at the port iPhone expects[2]. But no
need to worry, click OK.
7. At the next page, enter the "Advanced Settings" to specify the right
ports and paths
ports and paths
8. If you have SSL, turn the switch on. Note that port will be changed
to 8443.
to 8443.
9. Specify the port for the OpenERP server: 8071 for SSL, 8069 without.
10. Set the "Account URL" to the right path of the OpenERP webdav:
https://my.server.ip:8071/webdav/dbname/calendars
Where "https://my.server.ip:8071" is the protocol, server name
and port as discussed above, "dbname" is the name of the database.
[Note that the default
"https://my.server.ip:8071/principals/users/username" might also
be edited to
"https://my.server.ip:8071/webdav/dbname/principals/users/username" ]
https://my.server.ip:8071/webdav/dbname/calendars
Where "https://my.server.ip:8071" is the protocol, server name
and port as discussed above, "dbname" is the name of the database.
[Note that the default "https://my.server.ip:8071/principals/users/username" might also
be edited to "https://my.server.ip:8071/webdav/dbname/principals/users/username" ]
11. Click on Done. The phone will hopefully connect to the OpenERP server
and verify it can use the account.
and verify it can use the account.
12. Go to the main menu of the iPhone and enter the Calendar application.
Your OpenERP calendars will be visible inside the selection of the
"Calendars" button.
Your OpenERP calendars will be visible inside the selection of the
"Calendars" button.
Note that when creating a new calendar entry, you will have to specify
which calendar it should be saved at.
[1] I remember one guy that made *lots* of money selling his CA business
off, and since then uses this money to create a software monopoly.
[2] This may not happen if the SRV records at DNS and the well-known URIs
are setup right. But we appreciate that a default OpenERP installation will
not have the DNS server of the company's domain configured.
addons/caldav/doc/makefile
+13
View File
@@ -0,0 +1,13 @@
all: compile clean
concat: all.rst
cat all.rst iPhone.rst evolution.rst > compile.rst
compile: concat
rst2pdf compile.rst -o caldav_doc.pdf
clean:
rm compile.rst
del:
rm caldav_doc.pdf
addons/caldav/wizard/caldav_browse.py
+24 -2
View File
@@ -45,7 +45,29 @@ class caldav_browse(osv.osv_memory):
DATABASE_NAME: Name of database on which OpenERP Calendar is created
CALENDAR_NAME: Name of calendar to access
"""),
'iphone' : _("""It's complicated""")}
'iphone' : _("""It's complicated"""),
'evolution' : _("""
=========================================
Synchronization with Evolution's calendar
=========================================
1. Go to Calendar View
2. File -> New -> Calendar
3. Fill the form
- type : CalDav
- name : Whaterver you want (ie : Meeting)
- url : http://HOST:PORT/webdav/DB_NAME/calendars/users/USER/c/Meetings (ie : http://localhost:8069/webdav/db_1/calendars/users/demo/c/Meetings) the one given on the top of this window
- uncheck "User SSL"
- Username : Your username (ie : Demo)
- Refresh : everytime you want that evolution synchronize the data with the server
4. Click ok and give your openerp password
5. A new calendar named with the name you gave should appear on the left side.
""")}
_name = 'caldav.browse'
@@ -88,7 +110,7 @@ class caldav_browse(osv.osv_memory):
pref_ids = pref_ids[0]
url = host + ':' + str(port) + '/'+ pref_ids.service + '/' + cr.dbname + '/'+'calendars/'+ 'users/'+ current_user.login + '/'+ pref_ids.collection.name+ '/'+ pref_ids.calendar.name
res['description'] = self.__doc.get(pref_ids.device , self.__doc['other'])
file = open(addons.get_module_resource('caldav','doc', 'Caldav_doc.pdf'),'rb')
file = open(addons.get_module_resource('caldav','doc', 'caldav_doc.pdf'),'rb')
res['caldav_doc_file'] = base64.encodestring(file.read())