Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julienmalka/linkal
A public-calendar aggregator server
https://github.com/julienmalka/linkal
aggregator caldav caldav-server calendar nix-ci rust
Last synced: 3 days ago
JSON representation
A public-calendar aggregator server
- Host: GitHub
- URL: https://github.com/julienmalka/linkal
- Owner: JulienMalka
- License: gpl-3.0
- Created: 2022-09-20T02:38:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T20:33:52.000Z (10 months ago)
- Last Synced: 2024-02-05T21:42:04.379Z (10 months ago)
- Topics: aggregator, caldav, caldav-server, calendar, nix-ci, rust
- Language: Rust
- Homepage:
- Size: 122 KB
- Stars: 109
- Watchers: 3
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Linkal
[](https://www.rust-lang.org/)
[](https://builtwithnix.org)
Linkal is a public-calendar aggregator server. Given a set a public calendars links, it can make a CalDav client believe all these calendars are part of the same calendar collection. It makes it easy to source public calendars from multiples users and locations and easily distribute them to your end user.
It works by exposing the same endpoints as a real CalDav server, emulating responses when needed and otherwise forwarding the requests to the upstream servers.
## 🔧 How to build
### ❄ Nix users
```bash
nix build
```
### ❄ 👴🏼 Nix legacy users
```bash
nix-build
```
### 🐳 Docker users
One can build a docker image for docker by running `nix build .#docker-image`.
### Others
Having cargo installed, run ``cargo build``.
## Usage
### ⚙️ Configuration
Linkal is configured using a json file describing your calendars. The file has to follow this structure :
```json
{
"calendars": {
"https://calendar1.link/public-calendar/path": {
"name": "Calendar 1 name",
},
"https://calendar2.link/public-calendar/path": {
"name": "Calendar 2 name",
"color": "#c63b52",
}
}
}
```
The calendars have to be **public**. Linkal does not perform any authentification. The ``color`` field is optional. If provided, the color of the calendar will be overriden by Linkal. This is useful if several of the calendars you're aggregating have the same color.
### Running
```bash
linkal --calendar-file
```
This command will start the Linkal Server on port ``8443``. It is recommanded that you host Linkal behind a reverse proxy with https enabled (like Nginx for example).
### Add a linkal calendar in a CalDav client
To add a linkal aggregated calendar to your client, use as url either the ip/url of your server with port ``8443`` or the url that is set in your reverse proxy. The id and password that your client is asking can be set with any value.
Supported clients are :
- ✅ Thunderbird
- ✅ Apple calendar
⚠️ Some clients may need you to go to advanced options and hard set the port of the service, which would be ``443`` if you run Linkal behind a reverse proxy with https enabled.
If your calendar client is supported and not on this list, please open a pr/issue. If your favorite calendar client is not supported, open an issue.
## 🚧 Roadmap
Linkal is in development phase and can be succeptible to bugs. Identified elements for upcoming developments are :
- Parallel requests to answer to ``/cals`` requests
- Improve the auto discovery of the service
- More abstract handling of propfind requests
- More reasonable format of the config file
- Allowing to override more calendar fields
- Ability to serve multiple calendar collections
- Better support of the [RFC 4791](https://datatracker.ietf.org/doc/html/rfc4791) (Long term)
- Filtering protocol, if possible actionnable from the calendar client or a web interface (Long term)
- Supporting private calendars with auth en both sides