PHPackages                             sabre/katana - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sabre/katana

AbandonedArchivedProject[API Development](/categories/api)

sabre/katana
============

A CalDAV, CardDAV and WebDAV ready-to-use server on top of sabre/dav

0.4.2(10y ago)14921422[28 issues](https://github.com/sabre-io/katana/issues)[4 PRs](https://github.com/sabre-io/katana/pulls)AGPL-3.0JavaScriptPHP &gt;=5.4.7

Since Apr 23Pushed 7y ago21 watchersCompare

[ Source](https://github.com/sabre-io/katana)[ Packagist](https://packagist.org/packages/sabre/katana)[ Docs](http://sabre.io/katana/)[ RSS](/packages/sabre-katana/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (19)Versions (15)Used By (0)

Please note
===========

[](#please-note)

This project is **alpha** quality. We don't yet guarantee stability, data integrity or a clean upgrade path. Only use this project if you are interested in experimenting with it.

[![K (sabre/katana's logo)](public/static/image/katana_logo_full.png)](public/static/image/katana_logo_full.png)
================================================================================================================

[](#)

sabre/katana is a **contact**, **calendar**, **task list** and **file** server. Based on standards used worldwide (respectively [CardDAV](https://en.wikipedia.org/wiki/CardDAV), [CalDAV](https://en.wikipedia.org/wiki/CalDAV) and [WebDAV](https://en.wikipedia.org/wiki/WebDAV)), sabre/katana will sync your data between **any devices**, from **everywhere**, **every time**. It lets you manage users and their data in a minute. sabre/katana is powered by sabre/dav, an open source technology trusted by the likes of [Atmail](https://www.atmail.com/), [Box](https://www.box.com/blog/in-search-of-an-open-source-webdav-solution/), [fruux](https://fruux.com/) and [ownCloud](http://owncloud.org/).

Features
--------

[](#features)

Once sabre/katana has been installed, you will be able to manage:

- Users
- Address books
- Calendars
- Task lists
- Files

More than 35 RFCs are supported. See [the exhaustive list of all supported standars](http://sabre.io/dav/standards-support/). This includes: vCard 4.0, iCalendar 2.0, jCal, jCard, iTip, iMip, ACL etc.

Overview of features:

- WebDAV: Principals, users, HTTP authentification, ACL and synchronization
- Address books: VCF export
- Calendars: ICS export, scheduling (iTIP and iMIP, respectively invite attendees that are registered on your server or not)
- Task lists: ICS export
- Files: Home collection, public directory, locks

### Screenshots

[](#screenshots)

Easy step-by-step installation through a wizard:

[![Installation in the browser](https://camo.githubusercontent.com/944e72d9fa8ebd990b92608883a8e9e516b78e406a614caff7cb1c7b4f58e9da/68747470733a2f2f6661726d382e737461746963666c69636b722e636f6d2f373736352f31373139373336353537335f343731643838633264325f7a2e6a70673f31)](https://camo.githubusercontent.com/944e72d9fa8ebd990b92608883a8e9e516b78e406a614caff7cb1c7b4f58e9da/68747470733a2f2f6661726d382e737461746963666c69636b722e636f6d2f373736352f31373139373336353537335f343731643838633264325f7a2e6a70673f31)

You are also able to install in CLI:

[![Installation in the terminal](https://camo.githubusercontent.com/bda7286dfb6e94630307e94eca349a5261aaaa68494cc1877977d584b2c323f3/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353333372f31373831383030323138355f633137363231303961375f7a2e6a70673f31)](https://camo.githubusercontent.com/bda7286dfb6e94630307e94eca349a5261aaaa68494cc1877977d584b2c323f3/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353333372f31373831383030323138355f633137363231303961375f7a2e6a70673f31)

The login page, first step to manage your sabre/katana server:

[![Login page](https://camo.githubusercontent.com/cc95e75ee36791dc12cdd2f6dc8a32d603d6164768fbdb11839ef752b789ef33/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353334382f31373739313339393636365f383434643262323234385f7a2e6a70673f32)](https://camo.githubusercontent.com/cc95e75ee36791dc12cdd2f6dc8a32d603d6164768fbdb11839ef752b789ef33/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353334382f31373739313339393636365f383434643262323234385f7a2e6a70673f32)

List of users on the left:

[![List of users](https://camo.githubusercontent.com/7f4937b50d830993dc2614e598923c274ad9e22283465ce4b1333cd6298515d5/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383739332f31373139353231313330345f303138666232366562365f7a2e6a70673f33)](https://camo.githubusercontent.com/7f4937b50d830993dc2614e598923c274ad9e22283465ce4b1333cd6298515d5/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383739332f31373139353231313330345f303138666232366562365f7a2e6a70673f33)

When creating a new user, 1 address book, 2 calendars, 1 task list and 1 home collection (with a public directory) will be automatically created:

[![New user](https://camo.githubusercontent.com/b56dc5a42f7b584e3effea7c1a2cfd229f233d4d2e6b2d495ddfada68ad079d1/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353335302f31373831383138363835315f366133386339373932325f7a2e6a70673f34)](https://camo.githubusercontent.com/b56dc5a42f7b584e3effea7c1a2cfd229f233d4d2e6b2d495ddfada68ad079d1/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353335302f31373831383138363835315f366133386339373932325f7a2e6a70673f34)

You are able to create, edit, delete or download address books:

[![List of address books](https://camo.githubusercontent.com/fbbe62fbb7e53638b6856eec8a2f7a5dda0bd8fbd80e753882afaf4dbb4e4bde/68747470733a2f2f6661726d382e737461746963666c69636b722e636f6d2f373638392f31373632393930373639385f636331643965613933365f7a2e6a70673f34)](https://camo.githubusercontent.com/fbbe62fbb7e53638b6856eec8a2f7a5dda0bd8fbd80e753882afaf4dbb4e4bde/68747470733a2f2f6661726d382e737461746963666c69636b722e636f6d2f373638392f31373632393930373639385f636331643965613933365f7a2e6a70673f34)

You are also able to create, edit, delete or download calendars and task lists:

[![List of calendars](https://camo.githubusercontent.com/6552de848d0bb43f3f4e4d77dc5cc82e8cba7f9e62409c904cc0d87eea6e1e7c/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383834362f31373633303137343738305f303132363839356132365f7a2e6a70673f36)](https://camo.githubusercontent.com/6552de848d0bb43f3f4e4d77dc5cc82e8cba7f9e62409c904cc0d87eea6e1e7c/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383834362f31373633303137343738305f303132363839356132365f7a2e6a70673f36)

You can explore the home collection of a user. Notice the public directory - files put inside are accessible to anyone but no listing is available:

[![List of files](https://camo.githubusercontent.com/60f6de81519eafb4010bef55a23715adc32b25d42a56a1c94cf4f168f08dc503/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353333342f31373831383139383230315f353730373933373130315f7a2e6a70673f36)](https://camo.githubusercontent.com/60f6de81519eafb4010bef55a23715adc32b25d42a56a1c94cf4f168f08dc503/68747470733a2f2f6661726d362e737461746963666c69636b722e636f6d2f353333342f31373831383139383230315f353730373933373130315f7a2e6a70673f36)

Manage your settings easily:

[![Settings](https://camo.githubusercontent.com/c74a24728653d584da9f9f03e650c2da0b9205e2dead346de0ef08b5c7f6ff6a/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383834322f31383632383037383839325f636539366361343565325f7a2e6a70673f39)](https://camo.githubusercontent.com/c74a24728653d584da9f9f03e650c2da0b9205e2dead346de0ef08b5c7f6ff6a/68747470733a2f2f6661726d392e737461746963666c69636b722e636f6d2f383834322f31383632383037383839325f636539366361343565325f7a2e6a70673f39)

Attendees can be invited to an event even if they are not registered on your sabre/katana server by automatically sending an email:

[![Invite_attendees_by_email](https://camo.githubusercontent.com/e3c087cb22f0ddd81e8908b588da849c9b02e7b48a0fde0182387c25845e4e27/68747470733a2f2f6661726d312e737461746963666c69636b722e636f6d2f3336302f31383031303531363635345f643430366339326235305f7a2e6a70673f38)](https://camo.githubusercontent.com/e3c087cb22f0ddd81e8908b588da849c9b02e7b48a0fde0182387c25845e4e27/68747470733a2f2f6661726d312e737461746963666c69636b722e636f6d2f3336302f31383031303531363635345f643430366339326235305f7a2e6a70673f38)

Install
-------

[](#install)

If you downloaded sabre/katana as an archive, skip the pre-requisites.

### Pre-requisites

[](#pre-requisites)

To grab dependencies of the project, make sure you have [Composer](http://getcomposer.org/), [Bower](http://bower.io/) and [NPM](http://npmjs.org/) installed, and then run:

```
$ make install
```

(Note: You can run `make clean` to clean extra files needed for the installation).

Then, to install sabre/katana, you have two options.

### In your browser

[](#in-your-browser)

You need to start an HTTP server; example with the PHP built-in server:

```
$ php -S 127.0.0.1:8888 -t public public/.webserver.php
```

Then open [`http://127.0.0.1:8888/install.php`](http://127.0.0.1:8888/install.php) in your browser, you will be redirected to the installation page.

### In your terminal

[](#in-your-terminal)

You need to execute the following command:

```
$ bin/katana install
```

Update
------

[](#update)

To update sabre/katana, you have two options.

### In your browser

[](#in-your-browser-1)

So far, only a message will prompt you, indicating how to update manually. We are working on an automatic update in the browser.

### In your terminal

[](#in-your-terminal-1)

1. First solution is **manual** but more common. It requires a ZIP archive. Download the latest versions with the following command:

    ```
    $ bin/katana update --fetch-zip
    ```

    You will find the archives in the `data/share/update/` directory. To finish updating sabre/katana, simply run:

    ```
    $ unzip -u data/share/update/katana_vx.y.z.zip -d .
    ```
2. Second solution is **automatic** but less common. It requires a [PHAR](http://php.net/phar)archive. Download the latest versions with the following command:

    ```
    $ bin/katana update --fetch
    ```

    You will also find the archives in the `data/share/update/` directory. To finish updating sabre/katana, simply run:

    ```
    $ bin/katana update --apply data/share/update/katana_vx.y.z.phar
    ```

    The PHAR is executable. For instance:

    ```
    $ php data/share/update/katana_vx.y.z.phar --signature
    ```

    or

    ```
    $ php data/share/update/katana_vx.y.z.phar --metadata
    ```

    will respectively print the signature and the metadata of this version. Use `-h`, `-?` or `--help` to get help.

Supported technologies
----------------------

[](#supported-technologies)

So far, sabre/katana can be installed with [SQLite](http://sqlite.org/) or [MySQL](http://mysql.com/). It works in all major browsers, except prior versions of IE9.

Build status
------------

[](#build-status)

branchstatusmaster[![Build Status](https://camo.githubusercontent.com/f5827ac0890afc5abe5651111b3dbdec3290141f69c3ba2dbffd23839c2e0332/68747470733a2f2f7472617669732d63692e6f72672f73616272652d696f2f6b6174616e612e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/sabre-io/katana)Questions?
==========

[](#questions)

Head over to the [sabre/dav mailinglist](http://groups.google.com/group/sabredav-discuss), or you can also just [open a ticket on GitHub](https://github.com/fruux/sabre-katana/issues/).

Made at fruux
=============

[](#made-at-fruux)

sabre/katana is being developed by [fruux](https://fruux.com/). Drop us a line for commercial services or enterprise support.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 89.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~29 days

Recently: every ~45 days

Total

9

Last Release

3811d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2ec28c32d012f276f61b0b58cabe3c8f674166732d9b20eeddc3f9807857ba10?d=identicon)[evert](/maintainers/evert)

![](https://www.gravatar.com/avatar/d916220fea2bfe2d822214b0f188d1087035c66245431ae0dc2df4fbfbf81f6c?d=identicon)[dominik](/maintainers/dominik)

---

Top Contributors

[![Hywan](https://avatars.githubusercontent.com/u/946104?v=4)](https://github.com/Hywan "Hywan (630 commits)")[![evert](https://avatars.githubusercontent.com/u/178960?v=4)](https://github.com/evert "evert (59 commits)")[![DominikTo](https://avatars.githubusercontent.com/u/1384635?v=4)](https://github.com/DominikTo "DominikTo (12 commits)")[![lkraav](https://avatars.githubusercontent.com/u/147228?v=4)](https://github.com/lkraav "lkraav (1 commits)")[![staabm](https://avatars.githubusercontent.com/u/120441?v=4)](https://github.com/staabm "staabm (1 commits)")[![stevesbrain](https://avatars.githubusercontent.com/u/6745111?v=4)](https://github.com/stevesbrain "stevesbrain (1 commits)")

### Embed Badge

![Health badge](/badges/sabre-katana/health.svg)

```
[![Health](https://phpackages.com/badges/sabre-katana/health.svg)](https://phpackages.com/packages/sabre-katana)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)[hubspot/api-client

Hubspot API client

23914.2M16](/packages/hubspot-api-client)[monicahq/laravel-sabre

Sabre DAV server adapter for Laravel.

58434.2k](/packages/monicahq-laravel-sabre)[stfalcon-studio/api-bundle

Base classes and helper services to build API application via Symfony.

1032.1k](/packages/stfalcon-studio-api-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
