Skip to content

Commit 36a9967

Browse files
committed
docs: switch to AGPL
1 parent 42a9fb9 commit 36a9967

38 files changed

+1328
-76
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description = "CLI to manage contacts"
44
version = "0.1.0"
55
authors = ["soywod <clement.douin@posteo.net>"]
66
edition = "2021"
7-
license = "MIT"
7+
license = "AGPL-3.0-only"
88
categories = ["command-line-utilities"]
99
keywords = ["cli", "contact", "addressbook", "carddav", "webdav"]
1010
homepage = "https://pimalaya.org"

LICENSE

Lines changed: 661 additions & 21 deletions
Large diffs are not rendered by default.

SECURITY.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are
6+
currently being supported with security updates.
7+
8+
| Version | Supported |
9+
| ------- | ------------------ |
10+
| 0.1.x | :white_check_mark: |
11+
12+
## Reporting a Vulnerability
13+
14+
Use this section to tell people how to report a vulnerability.
15+
16+
Tell them where to go, how often they can expect to get an update on a
17+
reported vulnerability, what to expect if the vulnerability is accepted or
18+
declined, etc.

build.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// This file is part of Cardamum, a CLI to manage contacts.
2+
//
3+
// Copyright (C) 2025 soywod <clement.douin@posteo.net>
4+
//
5+
// This program is free software: you can redistribute it and/or
6+
// modify it under the terms of the GNU Affero General Public License
7+
// as published by the Free Software Foundation, either version 3 of
8+
// the License, or (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful, but
11+
// WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
// Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public
16+
// License along with this program. If not, see
17+
// <https://www.gnu.org/licenses/>.
18+
119
use pimalaya_toolbox::build::{features_env, git_envs, target_envs};
220

321
fn main() {

config.sample.toml

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -18,61 +18,61 @@ default = true
1818
#
1919
vdir.home-dir = "/tmp/posteo"
2020

21-
# ################################################################
22-
# # CardDAV section #
23-
# ################################################################
24-
# #
25-
# # Configuration of addressbooks relying on the CardDAV protocol, as
26-
# # defined in [RFC6352].
27-
# #
28-
# # [RFC6352]: https://datatracker.ietf.org/doc/html/rfc6352
21+
################################################################
22+
# CardDAV section #
23+
################################################################
24+
#
25+
# Configuration of addressbooks relying on the CardDAV protocol, as
26+
# defined in [RFC6352].
27+
#
28+
# [RFC6352]: https://datatracker.ietf.org/doc/html/rfc6352
2929

30-
# # There is 3 ways to find a CardDAV addressbook home URI:
31-
# #
32-
# # 1. By using HTTP discovery, as defined in the Well Known RFC8615
33-
# # 2. By using the root CardDAV server URI
34-
# # 3. By using directy the CardDAV addressbook home set URI
35-
# #
36-
# # The first method is the slowest because it requires a couple of HTTP
37-
# # requests to get the addressbook home URI, but it the safest because
38-
# # the URI should never change.
39-
# #
40-
# # The third method is the fastest because it requires only one single
41-
# # HTTP request, but it is the least safe because URI can change
42-
# # anytime.
43-
# #
44-
# # The second method can be a good compromise between speed and safety.
30+
# There is 3 ways to find a CardDAV addressbook home URI:
31+
#
32+
# 1. By using HTTP discovery, as defined in the Well Known RFC8615
33+
# 2. By using the root CardDAV server URI
34+
# 3. By using directy the CardDAV addressbook home set URI
35+
#
36+
# The first method is the slowest because it requires a couple of HTTP
37+
# requests to get the addressbook home URI, but it the safest because
38+
# the URI should never change.
39+
#
40+
# The third method is the fastest because it requires only one single
41+
# HTTP request, but it is the least safe because URI can change
42+
# anytime.
43+
#
44+
# The second method can be a good compromise between speed and safety.
4545

46-
# # To discover the CardDAV addressbook home URI, only the host name is
47-
# # required.
48-
# #
49-
# carddav.discover.host = "example.org"
50-
# #carddav.discover.port = 443
51-
# #carddav.discover.scheme = "https"
46+
# To discover the CardDAV addressbook home URI, only the host name is
47+
# required.
48+
#
49+
carddav.discover.host = "example.org"
50+
#carddav.discover.port = 443
51+
#carddav.discover.scheme = "https"
5252

53-
# # The root CardDAV server URI, which should contain all the users'
54-
# # addressbooks.
55-
# #
56-
# carddav.server-uri = "https://carddav.example.org"
53+
# The root CardDAV server URI, which should contain all the users'
54+
# addressbooks.
55+
#
56+
#carddav.server-uri = "https://carddav.example.org"
5757

58-
# # The CardDAV addressbook home URI, which should contain all your
59-
# # addressbooks.
60-
# #
61-
# carddav.home-uri = "https://carddav.example.org/principals"
58+
# The CardDAV addressbook home URI, which should contain all your
59+
# addressbooks.
60+
#
61+
#carddav.home-uri = "https://carddav.example.org/principals"
6262

63-
# # The plain authentication method (not safe).
64-
# #
65-
# #carddav.auth = "plain"
63+
# The plain authentication method (not safe).
64+
#
65+
#carddav.auth = "plain"
6666

67-
# # The Basic access authentication method.
68-
# #
69-
# carddav.auth.basic.username = "username"
70-
# carddav.auth.basic.password.command = ["pass", "show", "example"]
71-
# #carddav.auth.basic.password.keyring = "example-basic"
72-
# #carddav.auth.basic.password.raw = "password"
67+
# The Basic access authentication method.
68+
#
69+
carddav.auth.basic.username = "username"
70+
carddav.auth.basic.password.command = ["pass", "show", "example"]
71+
#carddav.auth.basic.password.keyring = "example-basic"
72+
#carddav.auth.basic.password.raw = "password"
7373

74-
# # The Bearer token authorization method, mainly for OAuth 2.0 usage.
75-
# #
76-
# #carddav.auth.bearer.command = ["ortie", "token", "show"]
77-
# #carddav.auth.bearer.keyring = "example-bearer"
78-
# #carddav.auth.bearer.raw = "oauth2-token"
74+
# The Bearer token authorization method, mainly for OAuth 2.0 usage.
75+
#
76+
#carddav.auth.bearer.command = ["ortie", "token", "show"]
77+
#carddav.auth.bearer.keyring = "example-bearer"
78+
#carddav.auth.bearer.raw = "oauth2-token"

flake.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/account/account.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// This file is part of Cardamum, a CLI to manage contacts.
2+
//
3+
// Copyright (C) 2025 soywod <clement.douin@posteo.net>
4+
//
5+
// This program is free software: you can redistribute it and/or
6+
// modify it under the terms of the GNU Affero General Public License
7+
// as published by the Free Software Foundation, either version 3 of
8+
// the License, or (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful, but
11+
// WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
// Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public
16+
// License along with this program. If not, see
17+
// <https://www.gnu.org/licenses/>.
18+
119
//! # Account configuration
220
//!
321
//! Module dedicated to account configuration.

src/account/de.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// This file is part of Cardamum, a CLI to manage contacts.
2+
//
3+
// Copyright (C) 2025 soywod <clement.douin@posteo.net>
4+
//
5+
// This program is free software: you can redistribute it and/or
6+
// modify it under the terms of the GNU Affero General Public License
7+
// as published by the Free Software Foundation, either version 3 of
8+
// the License, or (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful, but
11+
// WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
// Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public
16+
// License along with this program. If not, see
17+
// <https://www.gnu.org/licenses/>.
18+
119
#[allow(unused)]
220
use pimalaya_toolbox::feat;
321
use serde::Deserialize;

src/account/mod.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// This file is part of Cardamum, a CLI to manage contacts.
2+
//
3+
// Copyright (C) 2025 soywod <clement.douin@posteo.net>
4+
//
5+
// This program is free software: you can redistribute it and/or
6+
// modify it under the terms of the GNU Affero General Public License
7+
// as published by the Free Software Foundation, either version 3 of
8+
// the License, or (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful, but
11+
// WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
// Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public
16+
// License along with this program. If not, see
17+
// <https://www.gnu.org/licenses/>.
18+
119
mod account;
220
pub mod de;
321

src/addressbook/command/create.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// This file is part of Cardamum, a CLI to manage contacts.
2+
//
3+
// Copyright (C) 2025 soywod <clement.douin@posteo.net>
4+
//
5+
// This program is free software: you can redistribute it and/or
6+
// modify it under the terms of the GNU Affero General Public License
7+
// as published by the Free Software Foundation, either version 3 of
8+
// the License, or (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful, but
11+
// WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
// Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public
16+
// License along with this program. If not, see
17+
// <https://www.gnu.org/licenses/>.
18+
119
use anyhow::Result;
220
use clap::Parser;
321
use io_addressbook::addressbook::Addressbook;

0 commit comments

Comments
 (0)