AgenDAV Documentation Release 1.2.6.2 Jorge López Pérez July26,2015 Contents 1 Installationandconfiguration 3 1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.2 Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.3 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.4 TroubleshootingAgenDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2 TranslatingAgenDAV 15 2.1 Howtoaddatranslation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3 Releasenotes 17 3.1 1.2.6.1and1.2.6.2(2012-10-15) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.2 1.2.6(2012-09-03) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.3 1.2.5.1(2012-06-11) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.4 1.2.5(2012-06-07) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.5 1.2.4(2012-01-16) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.6 1.2.3(2011-11-08) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.7 1.2.2(2011-10-25) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.8 1.2.1(2011-10-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.9 1.2(2011-10-17) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.10 1.1.1(2011-09-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 i ii AgenDAVDocumentation,Release1.2.6.2 AgenDAV is a CalDAV web client which features an AJAX interface to allow users to manage their own calendars andsharedones. It’sreleasedundertheGPLv3license. Contents: Contents 1 AgenDAVDocumentation,Release1.2.6.2 2 Contents 1 CHAPTER Installation and configuration 1.1 Installation InthissectionyouwillbeabletoinstallAgenDAV. 1.1.1 Prerequisites AgenDAV1.2.6.2requiresthefollowingsoftwaretobeinstalled: • ACalDAVserver(developedmainlywithDAViCal • Awebserver • PHP>=5.3.0 • PHPmbstringextension • PHPcURLextension • MySQL>5.1orPostgreSQL>=8.1 1.1.2 Downloading AgenDAV and uncompressing AgenDAV1.2.6.2canbeobtainedatAgenDAVofficialwebpage,butyoucanuseGitHubtodownloadlatestversion. Havealookathttp://github.com/adobo/agendav. Uncompressitusingtar: $ tar xzf adobo-agendav-...tar.gz $ cd adobo-agendav-.../ 1.1.3 Database and tables AgenDAVrequiresadatabasetostoresomeinformation. SupportedRDBMsareMySQLandPostgreSQL. Firstofallyouhavetocreateauserandadatabaseforthatuser. Second,you’llhavetocreateinitialAgenDAVtablesusingprovidedSQLfilesinsidesql/directory. Laststepisapplyingdatabaseupgradestoinitialdatabasetables. 3 AgenDAVDocumentation,Release1.2.6.2 Steps1&2: MySQL CreateanuserinMySQLlikethis: $ mysql --default-character-set=utf8 -uroot -p Enter password: [...] mysql> GRANT ALL PRIVILEGES ON agendav.* TO agendav@localhost IDENTIFIED BY 'yourpassword' mysql> CREATE DATABASE agendav CHARACTER SET utf8 COLLATE utf8_general_ci; mysql> FLUSH PRIVILEGES; mysql> ^D Andthenruntheinitialschemacreationfile: $ mysql --default-character-set=utf8 -uagendav \ -p agendav < sql/mysql.schema.sql Enter password: $ Note the UTF8 parts on the previous commands. If you don’t specify them you will have some issues with special characters. Steps1&2: PostgreSQL Usethespecialpostgressystemusertomanageyourinstallation. Youcanaddanewuserandanewdatabasethe followingway: # su postgres $ psql postgres=# CREATE USER agendav WITH PASSWORD 'somepassword'; postgres=# CREATE DATABASE agendav ENCODING 'UTF8'; postgres=# GRANT ALL PRIVILEGES ON DATABASE agendav TO agendav; postgres=# \q $ exit Thenyouhavetoeditthefilepg_hba.conf,whichisusuallylocatedat/var/lib/pgsql/. Addthefollowing linebeforeotherdefinitions: # TYPE DATABASE USER CIDR-ADDRESS METHOD local agendav agendav trust AfterthatjustrestartPostgreSQLandloadtheinitialschema: $ psql -U agendav agendav < sql/pgsql.schema.sql Step3: Applylatestdatabaseschema Initialdatabasestructurecreatedwith*.sqlfilesprovidesonlyabasestructureforAgenDAV.Ithastobemodifiedto applylatestreleasechanges. Todothis,followinstructionsonDatabaseupgrade. 1.1.4 Configuring Apache web server Apachehastobeconfiguredtopointtoweb/publicdirectory,usingitsownVirtualHostorjustanAlias. Exampleusingadedicatedvirtualhost: 4 Chapter1. Installationandconfiguration AgenDAVDocumentation,Release1.2.6.2 <VirtualHost 1.2.3.4:443> ServerAdmin [email protected] DocumentRoot /path/to/agendav/web/public ServerName agendav.host ErrorLog logs/agendav_error_log CustomLog logs/agendav_access_log common </VirtualHost> ExampleusingtheAliasdirective: Alias /agendav /path/to/agendav/web/public Note: MakesurethatyouhavethefollowingPHPsettingsdisabled: • magic_quotes_gpc • magic_quotes_runtime Otherwebservers AgenDAVshouldworkonallotherwebserversoftwareiftheysupportPHPscripts,butthisisuntested. 1.1.5 Configure AgenDAV NowyoucanproceedtoconfigureAgenDAVfollowingtheConfigurationsection. 1.2 Upgrading AgenDAVupgradescanbesplitintotwosimplesteps. Before starting this process, make sure you have a backup of your current AgenDAV directory, specially the web/config/directory,anddumpyourdatabaseschemaandcontents. Please,donotcontinueunlessyouhavebothbackups. ReadalltheReleasenotesfromtheversionyouwereusingtocurrentrelease,becausesomeconfigurationfilesmay havechanged. ApplythosechangesafterupdatingthefilesfromAgenDAV. 1.2.1 Files upgrade a)Updatingfromtar.gzfile YoucanreplacethewholeAgenDAVdirectorywiththenewfiles,butit’srecommendedtokeepyouroldfolderwith adifferentname(e.g. agendav_old/). You’llneedittocopybackyourconfigurationfiles. Afterdownloadingthenewtar.gzfileanduncompressingit,copyyourconfigurationfilesfromtheolddirectory: $ cd agendav_old/web/config/ $ cp -a advanced.php caldav.php config.php database.php \ /path/to/new/agendav/web/config/ 1.2. Upgrading 5 AgenDAVDocumentation,Release1.2.6.2 b)Updatingfromgit IfyoudownloadedAgenDAVfromthegitrepositoryatGitHubthenyoucancheckoutlateststablereleasefromthe masterbranch,oranspecificversionusingitstag. Justpulllatestchangesandcheckoutthereleaseyouwant.Forexample,checkingoutAgenDAV1.2.5canbeachieved with: $ git pull [...] $ git checkout 1.2.5 1.2.2 Database upgrade Note: AgenDAV <= 1.2.5.1 have a bug that makes database upgrades to fail, complaining about a miss- ing migration_lang.php file. If you have AgenDAV configured to use a language other than English, set default_languagetoenbeforerunningagendav dbupdate The database upgrade process included in AgenDAV since 1.2.5 lets you apply the latest schema changes without havingtodealwith.sqlfilesandwithnoneedtocheckwhichfilesyoushouldapplytoyourcurrentversion. Justusetheprovidedbin/agendavcliscriptthisway: $ ./bin/agendavcli dbupdate 1.3 Configuration ConfiguringAgenDAVrequiresmodifyingsomePHPtextfileslocatedintheweb/config/directory. Thefollowingfilesareusuallyfoundasfilename.php.template,somakeacopyofthemwiththecorrectfile nametomakethemwork. Note: ldap.phpwasremovedinAgenDAV1.1.1 1.3.1 General configuration (config.php) config.phpfilespecifiesgeneraloptionsaboutAgenDAVenvironment. Itloadsasetofdefaultoptionvaluesfrom defaults.php,butitisrecommendedtoconfigureallofthefollowingvariables. Please,donotmodifydefaults.php,asitisafilethatupdatesoneveryAgenDAVupgradetoavoidproblemsif youforgetanyconfigurationsetting. base_url SpecifyhereyourfullpublicURLtoaccessAgenDAV,addingatrailingslash. Example: $config['base_url'] = 'https://agendav.host/'; show_in_log Arrayoflogginglevelswhichwillappearinlogs. Possiblelogginglevelsare: •ERROR:errormessages,recommended •INFO:informationalmessages,recommended 6 Chapter1. Installationandconfiguration