kopano_webapp/calendarimporter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

2.2.2 release, updated documentation, copyright updates

Browse Source
This commit is contained in:
Christoph Haas
2018-03-08 12:50:46 +01:00
parent 611b5162cc
commit 55bdf0a8d8
30 changed files with 192 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
backend/README.txt
View File

@@ -1,14 +1,54 @@
Backend setup:
# Backend setup:
1. Create a Admin User in Kopano:
## Installing the sync backend
### From source
Copy the whole folder "kopano-webapp-source\plugins\calendarimporter\backend" to a destination of cour choice.
For example:
```
cp -r kopano-webapp-source\plugins\calendarimporter\backend /opt/ical-sync/backend
```
### From precompiled download
Download the newest backend release from https://git.sprinternet.at/zarafa_webapp/calendarimporter/tree/master/DIST.
Unzip the downloaded file and copy the backend folder to a destination of cour choice.
For example:
```
cp -r Downloads\calendarimporter_backend /opt/ical-sync/backend
```
## Sync Backend Configuration
First you have to create a new Kopano user with admin rights.
For example:
```
kopano-admin -c adminuser -e admin@domain.com -f "Calendar Sync Admin" -p topsecretpw -a 1
```
Then edit the config.php file of the sync backend to fit your needs.
2. Edit the config.php to fit your needs.
Available configuration values:
3. Setup cron to run your script every 10 minutes (or whatever...)
| Configuration Value | Type | Default | Desctription |
| ------------- |:-------------:| ----- | ----- |
| $ADMINUSERNAME | string | "adminuser" | The newly created Kopano admin user |
| $ADMINPASSWORD | string | "topsecretpw" | The password of the admin user |
| $SERVER | string | "http://localhost:236/kopano" | Kopano Socket or HTTP(S) connection string |
| $CALDAVURL | string | "http://localhost:8080/ical/" | Kopano CalDAV URL |
| $TEMPDIR | string | "/tmp/" | Temporary path to store synchronised iCal files (must be writeable by the user executing the sync script) |
4. If you get an error, make sure that the mapi module is loaded for php-cli:
* Add: /etc/php5/cli/conf.d/50-mapi.ini
* Content: extension=mapi.so
Next set up a cronjob to allow periodic syncing of ical items.
Never run the backend script as root!
For example: (`/etc/crontab`):
```
# sync ics calendars every minute (interval can be changed by the user)
* * * * * icssync /opt/ical-sync/backend/sync.php > /var/log/icssync.log 2>&1
```
If you get an error, make sure that the mapi module is loaded for php-cli. Therefore create or modify: `/etc/php7/cli/conf.d/50-mapi.ini`
```
extension=mapi.so
```
Do no run the sync script as root! Create a user without admin rights (`adduser icssync`), and change permissions of the tmp folder accordingly.

2
backend/functions.php
View File

@@ -3,7 +3,7 @@
* functions.php, Kopano calender to ics im/exporter backend
*
* Author: Christoph Haas <christoph.h@sprinternet.at>
* Copyright (C) 2012-2016 Christoph Haas
* Copyright (C) 2012-2018 Christoph Haas
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public

2
backend/sync.php
View File

@@ -4,7 +4,7 @@
* sync.php, Kopano calender to ics im/exporter backend
*
* Author: Christoph Haas <christoph.h@sprinternet.at>
* Copyright (C) 2012-2017 Christoph Haas
* Copyright (C) 2012-2018 Christoph Haas
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public