2017 © Pedro PelĂĄez
 

project katana

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

image

sabre/katana

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

  • Tuesday, October 10, 2017
  • by dominik
  • Repository
  • 27 Watchers
  • 128 Stars
  • 182 Installations
  • JavaScript
  • 0 Dependents
  • 0 Suggesters
  • 19 Forks
  • 29 Open issues
  • 14 Versions
  • 0 % Grown

The README.md

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., (*1)

K (sabre/katana's logo)

sabre/katana is a contact, calendar, task list and file server. Based on standards used worldwide (respectively CardDAV, CalDAV and 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, Box, fruux and ownCloud., (*2)

Features

Once sabre/katana has been installed, you will be able to manage:, (*3)

  • Users
  • Address books
  • Calendars
  • Task lists
  • Files

More than 35 RFCs are supported. See the exhaustive list of all supported standars. This includes: vCard 4.0, iCalendar 2.0, jCal, jCard, iTip, iMip, ACL etc., (*4)

Overview of features:, (*5)

  • 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

Easy step-by-step installation through a wizard:, (*6)

Installation in the browser, (*7)

You are also able to install in CLI:, (*8)

Installation in the terminal, (*9)

The login page, first step to manage your sabre/katana server:, (*10)

Login page, (*11)

List of users on the left:, (*12)

List of users, (*13)

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:, (*14)

New user, (*15)

You are able to create, edit, delete or download address books:, (*16)

List of address books, (*17)

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

List of calendars, (*19)

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:, (*20)

List of files, (*21)

Manage your settings easily:, (*22)

Settings, (*23)

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

Invite_attendees_by_email, (*25)

Install

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

Pre-requisites

To grab dependencies of the project, make sure you have Composer, Bower and NPM installed, and then run:, (*27)

$ make install

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

Then, to install sabre/katana, you have two options., (*29)

In your browser

You need to start an HTTP server; example with the PHP built-in server:, (*30)

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

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

In your terminal

You need to execute the following command:, (*32)

sh $ bin/katana install, (*33)

Update

To update sabre/katana, you have two options., (*34)

In your browser

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

In your terminal

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

    sh $ bin/katana update --fetch-zip, (*37)

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

    sh $ unzip -u data/share/update/katana_vx.y.z.zip -d ., (*39)

  2. Second solution is automatic but less common. It requires a PHAR archive. Download the latest versions with the following command:, (*40)

    sh $ bin/katana update --fetch, (*41)

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

    sh $ bin/katana update --apply data/share/update/katana_vx.y.z.phar, (*43)

    The PHAR is executable. For instance:, (*44)

    sh $ php data/share/update/katana_vx.y.z.phar --signature, (*45)

    or, (*46)

    sh $ php data/share/update/katana_vx.y.z.phar --metadata, (*47)

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

Supported technologies

So far, sabre/katana can be installed with SQLite or MySQL. It works in all major browsers, except prior versions of IE9., (*49)

Build status

branch status
master Build Status

Questions?

Head over to the sabre/dav mailinglist, or you can also just open a ticket on GitHub., (*50)

Made at fruux

sabre/katana is being developed by fruux. Drop us a line for commercial services or enterprise support., (*51)

The Versions