{"id":13437887,"url":"https://github.com/etesync/etesync-dav","last_synced_at":"2025-05-15T05:07:22.599Z","repository":{"id":38419889,"uuid":"93647288","full_name":"etesync/etesync-dav","owner":"etesync","description":"This is a CalDAV and CardDAV adapter for EteSync","archived":false,"fork":false,"pushed_at":"2025-05-11T22:39:37.000Z","size":690,"stargazers_count":314,"open_issues_count":125,"forks_count":53,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-11T23:25:30.376Z","etag":null,"topics":["caldav","carddav","etesync","synchronization"],"latest_commit_sha":null,"homepage":"https://www.etesync.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/etesync.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"etesync","custom":"https://www.etesync.com/contribute/#donate"}},"created_at":"2017-06-07T14:54:02.000Z","updated_at":"2025-05-11T22:39:40.000Z","dependencies_parsed_at":"2024-01-16T10:36:57.616Z","dependency_job_id":"ab988b35-46f0-456a-bb1e-b346d3605e9f","html_url":"https://github.com/etesync/etesync-dav","commit_stats":{"total_commits":550,"total_committers":33,"mean_commits":"16.666666666666668","dds":0.1963636363636364,"last_synced_commit":"64edfb336f6ab6bbba66b80736c87a89dac2de03"},"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etesync%2Fetesync-dav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etesync%2Fetesync-dav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etesync%2Fetesync-dav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etesync%2Fetesync-dav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/etesync","download_url":"https://codeload.github.com/etesync/etesync-dav/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254276447,"owners_count":22043867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caldav","carddav","etesync","synchronization"],"created_at":"2024-07-31T03:01:00.971Z","updated_at":"2025-05-15T05:07:17.589Z","avatar_url":"https://github.com/etesync.png","language":"Python","funding_links":["https://github.com/sponsors/etesync","https://www.etesync.com/contribute/#donate"],"categories":["HarmonyOS","Python"],"sub_categories":["Windows Manager"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"120\" src=\"icon.svg\" /\u003e\n  \u003ch1 align=\"center\"\u003eEteSync - Secure Data Sync\u003c/h1\u003e\n\u003c/p\u003e\n\nThis is a CalDAV and CardDAV adapter for [EteSync](https://www.etesync.com)\n\n![GitHub tag](https://img.shields.io/github/tag/etesync/etesync-dav.svg)\n[![PyPI](https://img.shields.io/pypi/v/etesync-dav.svg)](https://pypi.python.org/pypi/etesync-dav/)\n[![Build Status](https://travis-ci.com/etesync/etesync-dav.svg?branch=master)](https://travis-ci.com/etesync/etesync-dav)\n[![Chat with us](https://img.shields.io/badge/chat-IRC%20|%20Matrix%20|%20Web-blue.svg)](https://www.etebase.com/community-chat/)\n\nThis package provides a local CalDAV and CardDAV server that acts as an EteSync compatibility layer (adapter).\nIt's meant for letting desktop CalDAV and CardDAV clients such as Thunderbird, Outlook and Apple Contacts connect with EteSync.\n\nIf all you want is to access your data from a computer, you are probably better off using [the web app](https://pim.etesync.com).\n\n# Installation\n\nThe easiest way to start using etesync-dav is by getting one of the pre-built binaries from the [releases page](https://github.com/etesync/etesync-dav/releases).\n\nThese binaries are self-contained and can be run as-is, though they do not start automatically on boot. You'd need to either start them manually, or set up [autostart based on your OS](#autostart-on-system-boot).\n\nFor Linux users there's a [short installation guide](https://github.com/etesync/etesync-dav/wiki/Installing-EteSync-DAV-on-Linux) in the wiki.\n\n# Configuration and running\n\n1. Run `etesync-dav` and open the management UI in your browser: http://localhost:37358/\n2. Add your EteSync user through the web UI.\n3. Copy the DAV specific password by click the \"Copy Password\" button next to your newly added username.\n\nFor advanced usage and CLI instructions please refer to [the advanced usage section](#advanced-usage).\n\n*Please note that some antivirus/internet security software may block the CalDAV/CardDAV service from running - make sure that etesync-dav is whitelisted.*\n\nDon't forget to set up EteSync to automatically start on startup. Instructions for this are unfortunately OS dependent and out of scope for this README.\n\n## Common environment variables\n\n* `ETESYNC_LISTEN_ADDRESS`: a hostname or IP address to listen on. Requests to a different host/ip will be block for the admin UI. Uses as the default value for the next setting.\n* `ETESYNC_SERVER_HOSTS`: defaults to `{ETESYNC_LISTEN_ADDRESS}:37358`. Otherwise, a list of IP masks, hostnames, and ports for the server to listen on. E.g. `0.0.0.0:37358,[::]:37358` for listening on all ipv4 and ipv6 addresses and port 37358, or `localhost:37358` to only allow requests from localhost.\n\n# Setting up clients\n\nYou now need to set up your CalDAV/CardDAV client using your username and the password you got in the previous step.\n\nDepending on the client you use, the server path should either be:\n\n* `http://localhost:37358/`\n* `http://localhost:37358/YOUR-USERNAME/`\n\nOn most clients this should automatically detect your collections (i.e.\ncalendars and address books).\n\nIf your client does not automatically detect your collections, you will\nneed to manually add them. You can find the links in the management UI\nwhen you click on your username.\n\n## Specific client notes and instructions\n\n### Thunderbird\n\n#### Thunderbird (using native CalDAV and CardDAV support available as of [Thunderbird 91](https://support.mozilla.org/en-US/kb/new-thunderbird-91)) - preferred\n\n##### To add calendars\n1. Add a calendar by hitting the \"+\" symbol in the toolbar that is usually on the left of Thunderbird's Calendar view, or right-click for the context menu and select \"New Calendar\"\n2. Select the \"On the Network\" radio button\n3. For Username put the name of your local Etesync account\n4. For Location, you will get the information from Etesync. Head to http://localhost:37358/.web/login/ and log in\n5. Then click the link to collection list\n6. Then copy the link for the calendar you're trying to add, and put that in for Location in the Thunderbird dialog\n7. Click \"Find Calendars\"\n8. You will see a \"Password Required\" popup. You need to get the password from the Etesync web interface. Go back to http://localhost:37358/.web/ and click the \"Copy Password\" button. Paste this password in the Thunderbird popup.\n9. Hit Subscribe and you are finished, that calendar is added\n10. Repeat for any additional calendars\n\n##### To add address books\n1. Click the \"Address Book\" icon in Thunderbird's mail view to open the Address Book\n2. Within the Address Book, click File--\u003eNew--\u003eCardDAV Address Book\n3. For Username put the name of your local Etesync account\n4. For Location, you will get the information from Etesync. Head to http://localhost:37358/.web/login/ and log in\n5. Then click the link to collection list\n6. Then copy the link for the address book you're trying to add, and put that in for Location in the Thunderbird dialog\n7. Click \"Continue\"\n8. You will see a \"Password Required\" popup. You need to get the password from the Etesync web interface. Go back to http://localhost:37358/.web/ and click the \"Copy Password\" button. Paste this password in the Thunderbird popup.\n9. Hit Subscribe and you are finished, that address book is added\n10. Repeat for any additional address books\n\n#### Thunderbird (using TbSync, for Thurderbird older than version 91)\n1. Install [TbSync](https://addons.thunderbird.net/en-us/thunderbird/addon/tbsync/) and the accompanying [DAV provider](https://addons.thunderbird.net/en-us/thunderbird/addon/dav-4-tbsync/).\n2. Open the TbSync window: Edit -\u003e TbSync\n3. Add new DAV account (choose manual configuration).\n4. Use `http://localhost:37358/` for both servers, your EteSync username as the username and the DAV password you got in [configuration and running](#configuration-and-running) as the password.\n\n**Note:** if you enabled SSL in etesync-dav, you should follow the [TbSync instructions for self-signed certificates](https://github.com/jobisoft/TbSync/wiki/How-to-use-TbSync-with-self-signed-or-otherwise-untrusted-certificates%3F).\n\n#### Thunderbird (no additional add-ons, for Thurderbird older than version 91)\nTbSync includes address book support (Lightning does not), automatically discovers all your calendars/address books/tasks, and just works better in general than this solution for versions of Thunderbird older than 91. However, you *can* also do the following:\n\n1. Install a CardDAV add-on such as Cardbook if you want to sync your contacts\n2. Open http://localhost:37358 in a browser, log in with your username and account password (not encryption password), and click on the link to your DAV colection to see a list of all the calendars, tasks lists, and address books in that collection\n3. For each item in the collection that you want to sync, copy the \\[link] address and subscribe to that address in Thunderbird using `File \u003e New Calendar \u003e On the Network \u003e CalDav` for calendars and tasks, or `New Address Book \u003e Remote \u003e CardDav` in Cardbook for address books\n\n### Evolution / GNOME Contacts / GNOME Calendar\nGNOME Contacts does not support adding remote address books directly, but you can add them in Evolution and they will appear correctly in all the apps. GNOME Calendar does support adding webdav calendars directly in GNOME Calendar. Calendars can also be added in Evolution and they will appear correctly in all the apps.\n\n1. Open Evolution and click File -\u003e New -\u003e Collection account\n2. Put your username in the user field.\n3. Click Advanced Options and use `http://localhost:37358/` as the server.\n4. Make sure \"Look up for a CalDAV/CardDAV server\" is ticked, and untick all the rest.\n5. Click \"Look Up\" and when prompted, the DAV password you got in [configuration and running](#configuration-and-running).\n6. Click Next/Finish until done.\n\n### Windows 10 (Outlook, Windows Calendar and Windows People)\nWhile EteSync-DAV works great on Windows 10, due to bugs in Windows itself, the instructions require a few extra steps for syncing with Outlook, Windows Calendar and Windows people. Other clients, such as Thunderbird, do no require these extra steps.\n\nPlease take a look at the [Windows 10 instructions](https://github.com/etesync/etesync-dav/wiki/Windows-10-instructions) for more information.\n\n### macOS (Contacts.app and Calendar.app)\nWhile EteSync-DAV works great on macOS, due to bugs in macOS Mojave, the instructions require a few extra steps for syncing with Contacts.app and Calendar.app. Other clients, such as Thunderbird, do no require these extra steps.\n\nPlease take a look at the [macOS instructions](https://github.com/etesync/etesync-dav/wiki/MacOS-instructions) for more information.\n\n### iOS\n\nBy default, iOS only syncs events 30 days old and newer, which may look as if\nevents are not showing. To fix this, got to: Settings -\u003e Calendar -\u003e Sync and\nchange to the wanted time duration.\n\nOr better yet, just use the [EteSync iOS client](https://github.com/etesync/ios).\n\n## Autostart on system boot\n\nIt's probably easiet to just follow [these instructions](https://www.howtogeek.com/228467/how-to-make-a-program-run-at-startup-on-any-computer/) for setting up autostart. Alternatively, you can try following the instructions below.\n\n### Linux (systemd)\n\nMake sure you have `/usr/lib/systemd/user/etesync-dav.service` on your system (should be there when installing from your distro's package manager), and then, to start the service:\n`systemctl --user start etesync-dav`\nTo enable auto-start on boot:\n`systemctl --user enable etesync-dav`\n\n### macOS\n\nMake sure you installed `etesync-dav.app` by dragging it to your `Applications` directory through finder.\nEnable autostart by for example following [these instructions](https://www.howtogeek.com/228467/how-to-make-a-program-run-at-startup-on-any-computer/).\n\n### Windows\n\nFollow [these instructions](https://www.howtogeek.com/228467/how-to-make-a-program-run-at-startup-on-any-computer/).\n\n# Alternative Installation Methods\n\nThis methods are not as easy as the pre-built binaries method above, but are also simple. Please follow the instructions below, following which follow the instructions in the [Configuration and running](#configuration-and-running) section below.\n\n## Docker\n\nRun one time initial setup to persist the required configuration into a docker volume. Check out the configuration section below for more information.\n\n    docker run -it --rm -v etesync-dav:/data etesync/etesync-dav manage add USERNAME\n\nRun etesync-dav in a background docker container with configuration from previous step. This wil (re)start the container on boot and after crashes.\n\n    docker run --name etesync-dav -d -v etesync-dav:/data -p 37358:37358 --restart=always etesync/etesync-dav\n    \nAfter this, refer to the [Setting up clients](#setting-up-clients) section below and start using it!\n\n### Updating\n\nTo update to the latest version of the docker image, run:\n\n    docker pull etesync/etesync-dav\n\n## Arch Linux\n\nThe package `etesync-dav` is [available on AUR](https://aur.archlinux.org/packages/etesync-dav/).\n\nThe package comes with a systemd unit. To see the status of the systemd service, run:\n\n    systemctl --user status etesync-dav\n\nTo inspect the logs, run:\n\n    journalctl --user -xeu etesync-dav\n\n## Windows systems\n\nYou can either follow the Docker instructions above (get Docker [here](https://www.docker.com)), or alternatively install Python3 for windows from [here](https://www.python.org/downloads/windows).\n\n## Python virtual environment (Linux, BSD and Mac)\n\nInstall virtual env (for **Python 3**) from your package manager, for example:\n\n- Arch Linux: pacman -S python-virtualenv\n- Debian/Ubuntu: apt-get install python3-virtualenv\n\nThe bellow commands will install etesync to a directory called `venv` in the local path. To install to a different location, just choose a different path in the commands below.\n\nSet up the virtual env:\n\n    virtualenv -p python3 venv\n    source venv/bin/activate\n    pip install etesync-dav\n\nRun the etesync commands as explained in the [Configuration and running](#configuration-and-running) section:\n\n    ./venv/bin/etesync-dav manage ...\n    ./venv/bin/etesync-dav ...\n\nPlease note that you'll have to run `source venv/bin/activate` every time you'd like to run the EteSync commands.\n\n# Advanced usage\n\n## CLI\n\n1. Open a terminal and navigate to the binary's loctaion by typing `cd /path/to/file` (most likely `cd ~/Downloads`).\n2. Rename the binary to `etesync-dav` for ease of use, by e.g: `mv linux-etesync-dav etesync-dav`\n3. Make it executable: `chmod +x etesync-dav`\n\nYou need to first add an EteSync user using `./etesync-dav manage`, for example:\n\n`./etesync-dav manage add USERNAME`\n\n*Substitute `USERNAME` with the username you use with your\nEteSync account or self-hosted server.*\n\nand then run the server:\n`./etesync-dav`\n\n**Note:** if you are using this with the legacy etesync server you should also pass `--legacy`\n\n## Self-hosting\n\nIf you are self-hosting the EteSync server, just enter your server URL when adding your account.\nAlternatively, you can set the default URL to be used by setting the `ETESYNC_URL` environment\nvariable to the URL of your server when running etesync-dav.\nBy default it uses the official EteSync server at `etesync.com`.\n\n## Using a proxy\n\nEteSync-DAV should automatically use the system's proxy settings if set correctly. Alternatively, you can set the `HTTP_PROXY` and `HTTPS_PROXY` environment variables to manually set the proxy settings.\n\n## Self Signed Certs\n\nIf the etesync backend server is using self signed certs, the DAV bridge may refuse to connect. To solve this, run the following commands prior to starting the DAV bridge.\n\n`export REQUESTS_CA_BUNDLE=/path/to/your/certificate.pem`\n\nor\n\n`export SSL_CERT_FILE=/path/file.crt`\n\nAlternatively, if the security of certificate is not an issue (say the server is on a private network and not publicly accessible), you can ignore the certificate completely with the following commands prior to starting the DAV bridge.\n\n```bash\nexport CURL_CA_BUNDLE='';\nexport REQUESTS_CA_BUNDLE='';\n```\n\n## Debugging\n\nIn order to put `etesync-dav` in debug mode so it print extra debug information please pass it the `-D` flag like so:\n\n```bash\n./etesync-dav -D\n```\n\nWhile this works on Linux, BSD and macOS, the Windows pre-compiled binary is compiled in \"no console\" mode, which means\nit can't print to the terminal. In order to get the debug information on Windows, please redirect the output log to\nfile, like so:\n\n```bash\nset ETESYNC_LOGFILE=output.log\netesync-dav.exe -D\n```\n\n## Data files\n\n`etesync-dav` stores data in the directory specified by the `ETESYNC_DATA_DIR`\nenvironment variable. This includes a database and the credentials cache.\n\n`ETESYNC_DATA_DIR` defaults to a subdirectory of the appropriate data directory\nfor your platform. For example:\n1. `~/.local/share/etesync-dav` on Linux.\n2. `~/Library/Application Support/etesync-dav` on macOS\n3. `C:\\Documents and Settings\\\u003cUser\u003e\\Application Data\\Local Settings\\etesync\\etesync-dav` on older Windows\n4. `C:\\Users\\\u003cUser\u003e\\AppData\\Local\\etesync\\etesync-dav` on Windows 7 and up (Most likely)\n\nSee the [appdirs](https://pypi.python.org/pypi/appdirs) module docs for mor examples.\n\n# Credits\n\nThis depends on the [Radicale server](https://radicale.org) for operation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetesync%2Fetesync-dav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fetesync%2Fetesync-dav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetesync%2Fetesync-dav/lists"}