Popularity
2.5
Growing
Activity
8.7
-
126
10
15

Programming language: PHP
License: MIT License
Tags: Calendaring And Contacts Management     Calypso    
Latest version: v1.5.0

Davis alternatives and similar software solutions

Based on the "calypso" category.
Alternatively, view Davis alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Davis or a related project?

Add another 'calypso' Software solution

README

Davis

Build Status Publish Docker image Latest release Sponsor me

A simple, fully translatable admin interface and frontend for sabre/dav based on Symfony 5 and Bootstrap 4, initially inspired by Baïkal.

Provides user edition, calendar creation and sharing, address book creation and sharing. The interface is simple and straightforward, responsive, and provides a light and a dark mode.

Easily containerisable (Dockerfile and sample docker-compose configuration file provided).

Supports Basic authentication, as well as IMAP and LDAP (via external providers).

Created and maintained (with the help of the community) by @tchapi.

[Dashboard page](_screenshots/dashboard.png) [User creation page](_screenshots/user.png) [Sharing page](_screenshots/sharing.png)

Requirements

  • PHP > 7.3.0 (with pdo_mysql, gd and intl extensions), MySQL (or MariaDB), compatible up to PHP 8.1
  • Composer > 2 (The last release compatible with Composer 1 is v1.6.2)
  • The imap and ldap PHP extensions if you want to use either authentication methods (these are not enabled / compiled by default)

Installation

  1. Clone this repository

  2. Retrieve the dependencies:

composer install
  1. At least put the correct credentials to your database in your .env.local file so you can easily create your database.

  2. Create the database:

bin/console doctrine:schema:create

Davis can be used with a pre-existing MySQL database (for instance, one previously managed by Baïkal). The only missing table would be the migrations table, that you can recreate automatically when running the migrations.

The migrations are not exactly equivalent to those of Baïkal, and allow for a bit more room in columns.

Configuration

Create your own .env.local file to change the necessary variables, if you plan on using symfony/dotenv.

If your installation is behind a web server like Apache or Nginx, you can setup the env vars directly in your Apache or Nginx configuration (see below). Skip this part in this case.

a. The database url (you should already have it configured since you created the database previously)

DATABASE_URL=mysql://db_user:[email protected]:3306/db_name

b. The admin password for the backend

ADMIN_LOGIN=admin
ADMIN_PASSWORD=test

c. The auth Realm and method for HTTP auth

AUTH_REALM=SabreDAV
AUTH_METHOD=Basic # can be "Basic", "IMAP" or "LDAP"

See the following paragraph for more information if you choose either IMAP or LDAP.

d. The global flags to enable CalDAV, CardDAV and WebDAV

CALDAV_ENABLED=true
CARDDAV_ENABLED=true
WEBDAV_ENABLED=false

e. The email address that your invites are going to be sent from

[email protected]

f. The paths for the WebDAV installation

I recommend that you use absolute directories so you know exactly where your files reside.

TMP_DIR='/tmp'
PUBLIC_DIR='/public'

Specific environment variables for IMAP and LDAP authentication methods

In case you use the IMAP auth type, you must specify the auth url (the "mailbox" url) in IMAP_AUTH_URL. See https://www.php.net/manual/en/function.imap-open.php for more details.

You should also explicitely define whether you want new authenticated to be created upon login:

IMAP_AUTH_URL="{imap.gmail.com:993/imap/ssl/novalidate-cert}"
IMAP_AUTH_USER_AUTOCREATE=true # false by default

Same goes for LDAP, where you must specify the LDAP server url, the DN pattern, the Mail attribute, as well as whether you want new authenticated to be created upon login (like for IMAP):

LDAP_AUTH_URL="ldap://127.0.0.1"
LDAP_DN_PATTERN="mail=%u"
LDAP_MAIL_ATTRIBUTE="mail"
LDAP_AUTH_USER_AUTOCREATE=true # false by default

Ex: for Zimbra LDAP, you might want to use the zimbraMailDeliveryAddress attribute to retrieve the principal user email:

   LDAP_MAIL_ATTRIBUTE="zimbraMailDeliveryAddress"

Migrating from Baïkal ?

If you're migrating from Baïkal, then you will likely want to do the following :

  1. Get a backup of your data (without the CREATE statements, but with complete INSERT statements):

    mysqldump -u root -p --no-create-info --complete-insert baikal > baikal_to_davis.sql # baikal is the actual name of your database

  2. Create a new database for Davis (let's name it davis) and create the schema :

    bin/console doctrine:schema:create

  3. Reimport the data back:

    mysql -uroot -p davis < baikal_to_davis.sql

Access / Webserver

A simple status page is available on the root / of the server.

The administration interface is available at /dashboard. You need to login to use it (See ADMIN_LOGIN and ADMIN_PASSWORD env vars).

The main endpoint for CalDAV, WebDAV or CardDAV is at /dav.

Note: For shared hosting, the symfony/apache-pack is included and provides a standard .htaccess file in the public directory so redirections should work out of the box.

Example Caddy 2 configuration

dav.domain.tld {
    # General settings
    encode zstd gzip
    header {
        -Server
        -X-Powered-By

        # enable HSTS
        Strict-Transport-Security max-age=31536000;

        # disable clients from sniffing the media type
        X-Content-Type-Options nosniff

        # keep referrer data off of HTTP connections
        Referrer-Policy no-referrer-when-downgrade
    }

    root * /var/www/davis/public
    php_fastcgi 127.0.0.1:8000
    file_server
}

Example Apache 2.4 configuration

<VirtualHost *:80>
    ServerName dav.domain.tld

    DocumentRoot /var/www/davis/public
    DirectoryIndex /index.php

    <Directory /var/www/davis/public>
        AllowOverride None
        Order Allow,Deny
        Allow from All
        FallbackResource /index.php
    </Directory>

    # Apache > 2.4.25, else remove this part
    <Directory /var/www/davis/public/bundles>
        FallbackResource disabled
    </Directory>

    # Env vars (if you did not use .env.local)
    SetEnv APP_ENV prod
    SetEnv APP_SECRET <app-secret-id>
    SetEnv DATABASE_URL "mysql://db_user:[email protected]:3306/db_name"
    # ... etc
</VirtualHost>

Example Nginx configuration

server {
    server_name dav.domain.tld;
    root /var/www/davis/public;

    location / {
        try_files $uri /index.php$is_args$args;
    }

    location /bundles {
        try_files $uri =404;
    }

    location ~ ^/index\.php(/|$) {
        fastcgi_pass unix:/var/run/php/php7.2-fpm.sock; # Change for your PHP version
        fastcgi_split_path_info ^(.+\.php)(/.*)$;
        include fastcgi_params;

        # Env vars (if you did not use .env.local)            fastcgi_param APP_ENV prod;
        fastcgi_param APP_SECRET <app-secret-id>;
        fastcgi_param DATABASE_URL "mysql://db_user:[email protected]:3306/db_name";
        # ... etc ...

        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        fastcgi_param DOCUMENT_ROOT $realpath_root;
        internal;
    }

    location ~ \.php$ {
        return 404;
    }
}

More examples and information here.

Well-known redirections for CalDAV and CardDAV

Web-based protocols like CalDAV and CardDAV can be found using a discovery service. Some clients require that you implement a path prefix to point to the correct location for your service. See here for more info.

If you use Apache as your webserver, you can enable the redirections with:

RewriteEngine On
RewriteRule ^\.well-known/carddav /dav/ [R=301,L]
RewriteRule ^\.well-known/caldav /dav/ [R=301,L]

Make sure that mod_rewrite is enabled on your installation beforehand.

If you use Nginx, you can add this to your configuration:

location / {
   rewrite ^/.well-known/carddav /dav/ redirect;
   rewrite ^/.well-known/caldav /dav/ redirect;
}

Dockerized installation

A Dockerfile is available for you to compile the image.

To build the checked out version, just run:

docker build --pull --file docker/Dockerfile --tag davis:latest .

This will build a davis:latest image that you can directly use. Do not forget to pass sensible environment variables to the container since the dist .env file will take precedence if no .env.local or environment variable is found.

You can also use the release image created on the Github container registry: ghcr.io/tchapi/davis:edge

Full stack

A docker-compose.yml file is also included (in the docker folder) as a minimal example setup with a MariaDB database and Nginx as a reverse proxy.

You can start the containers with :

cd docker && docker-compose up -d

⚠ Do not forget to create the database the first time you run the container :

docker exec -it davis bash -c "APP_ENV=prod bin/console doctrine:schema:create --no-interaction"

Then, head up to http://<YOUR_DOCKER_IP>:9000 to see the status display :

[Status page](_screenshots/status.png)

Note that there is no user and no principals created by default.

Development

You can spin off a local PHP webserver with:

php -S localhost:8000 -t public

If you change or add translations, you need to update the messages XLIFF file with:

bin/console translation:update en --force --domain=messages+intl-icu

Libraries used

  • Symfony 5 (Licence : MIT)
  • Sabre-io/dav (Licence : BSD-3-Clause)
  • Bootstrap 4 (Licence : MIT)

This project does not use any pipeline for the assets since the frontend side is relatively simple, and based on Bootstrap.

Licence

This project is release under the MIT licence. See the LICENCE file