sabre / katana
A CalDAV, CardDAV and WebDAV ready-to-use server on top of sabre/dav
Installs: 212
Dependents: 0
Suggesters: 0
Security: 0
Stars: 152
Watchers: 24
Forks: 22
Open Issues: 32
Language:JavaScript
Type:project
Requires
- php: >=5.4.7
- ext-pdo: >=1.0
- ext-spl: *
- hoa/console: ~2.0
- hoa/core: ~2.0, >=2.15.04.13
- hoa/dispatcher: ~0.0, >=0.15.01.23
- hoa/eventsource: ~2.0
- hoa/file: ~0.15.05.27
- hoa/iterator: ~1.0
- hoa/mail: ~0.0, >=0.15.06.03
- hoa/mime: ~2.0
- hoa/router: ~2.0
- hoa/socket: ~0.0, >=0.15.02.25
- hoa/stringbuffer: ~0.0
- hoa/ustring: ~3.0
- ircmaxell/password-compat: ~1.0
- sabre/dav: ~3.0.1
Requires (Dev)
- atoum/atoum: ~2.1
- atoum/praspel-extension: ~0.1
- atoum/ruler-extension: ~1.0, >=1.0.2
- hoa/regex: ~0.15.08.13
- sabre/cs: ~0.0.4
Suggests
- ext-pdo_mysql: If you decide to use MySQL.
- ext-pdo_sqlite: If you decide to use SQLite.
- ext-phar: If you plan to package sabre/katana as a phar archive
This package is auto-updated.
Last update: 2020-01-25 23:37:20 UTC
README
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.
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.
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. 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
Easy step-by-step installation through a wizard:
You are also able to install in CLI:
The login page, first step to manage your sabre/katana server:
List of users on the left:
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:
You are able to create, edit, delete or download address books:
You are also able to create, edit, delete or download calendars and task lists:
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:
Manage your settings easily:
Attendees can be invited to an event even if they are not registered on your sabre/katana server by automatically sending an email:
Install
If you downloaded sabre/katana as an archive, skip the pre-requisites.
Pre-requisites
To grab dependencies of the project, make sure you have Composer, Bower and NPM 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
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
in your
browser, you will be redirected to the installation page.
In your terminal
You need to execute the following command:
$ bin/katana install
Update
To update sabre/katana, you have two options.
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.
In your terminal
-
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 .
-
Second solution is automatic but less common. It requires a 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
So far, sabre/katana can be installed with SQLite or MySQL. It works in all major browsers, except prior versions of IE9.
Build status
branch | status |
---|---|
master |
Questions?
Head over to the sabre/dav mailinglist, or you can also just open a ticket on GitHub.
Made at fruux
sabre/katana is being developed by fruux. Drop us a line for commercial services or enterprise support.