32 Commits

Author SHA1 Message Date
Alberto Bertogli
2f17f570b3 docs: Add references to the Alpine package
Thanks to raspbeguy (https://github.com/raspbeguy) for creating and
maintaining the Alpine package.
2025-01-19 18:18:52 +00:00
Alberto Bertogli
6ff08b1ec2 ci: Rename master branch to main
These days `main` is more common, and I find it more intuitive.
2024-04-19 18:57:30 +01:00
Alberto Bertogli
76a72367ae dkim: Implement internal dkim signing and verification
This patch implements internal DKIM signing and verification.
2024-03-12 20:43:21 +00:00
Alberto Bertogli
2e279de304 github: Run coverage tests
This patch adds a job to the docker workflow to run coverage tests, and
upload the results to coveralls.
2023-07-28 10:05:15 +01:00
Alberto Bertogli
9e8452520a docs: Update badge/link to the CI status
The current badge, which covers all the branch checks doesn't work, it
always says "pending".

This patch replaces it with the gotest workflow status. It is much more
narrow, but at least it works and gives a decent indication of the
testing status.
2023-05-24 22:18:12 +01:00
Alberto Bertogli
795f2a7ceb ci: Use Github Actions to run integration tests and push Docker images
We're running against the usage limits in Gitlab CI (500), and Github
Actions should have more (2000).

So this patch replaces Gitlab CI with Github actions for running
integration tests, and build and push Docker images (to Dockerhub and
Gitlab registry).

We'll see how the usage levels are in a few months.
2022-11-13 19:16:10 +00:00
Alberto Bertogli
c2f2e4c7bb doc: Expand contact to include GitHub issues, and security reports
This patch extends the README to mention explicitly that reporting bugs
and sending patches on GitHub is welcome, and also adds a private email
where to report security issues.

The changes matches the common practice so far, but it's useful to have
it explicitly documented.
2021-06-06 02:10:01 +01:00
Alberto Bertogli
ec7234c0a9 docs: #chasquid has moved to OFTC
The IRC channel has been moved to OFTC, reflect that in the
documentation.
2021-05-23 10:15:44 +01:00
Alberto Bertogli
7914590cfa docs: Update and extend links to distribution packages
This patch updates and extends the links to the distribution packages,
referencing them from the README (it's more likely to be what the reader
wants to see), and also extending the Arch packaging with binary package
information.
2020-09-13 11:31:31 +01:00
Alberto Bertogli
607a455b20 docs: Update README links to the documentation
The documentation is now available directly at
https://blitiri.com.ar/p/chasquid/, so remove the /docs/ suffix from the
links in the README.

The /docs/ variant will continue to be functional for a while anyway.
2020-07-30 00:16:14 +01:00
Alberto Bertogli
4367c9e059 travis: Remove references in documentation, allow to fail
The Travis tests don't work due to a Travis networking issue reaching
some external hosts.

Until it is fixed, remove references from the documentation, since its
output is misleading.

We also allow it to fail, which makes the GitHub UI not show commits as
having failed tests because of Travis.

Since the previous commit, GitLab CI does almost all the same tests, so
there should be no significant loss of coverage anyway.
2020-05-22 12:11:27 +01:00
Alberto Bertogli
d60c03f4d2 tests: Add Cirrus CI integration
This patch adds a configuration for https://cirrus-ci.org/, which
includes running the Go tests on FreeBSD.
2020-04-14 12:01:01 +01:00
Alberto Bertogli
6815cf1d5c docs: Add Arch installation instructions
There is an AUR package for chasquid, so this patch adds references to
it in the documentation.

Thanks to Max Mazurov (fox.cpp@disroot.org) for adding the package.
2020-03-28 17:59:46 +00:00
Alberto Bertogli
809578cb57 README: Update links and shields
This patch updates the README file, adjusting some of the existing
references, as well as adding new ones (mainly pointing to new
documentation).
2019-10-25 16:00:15 +01:00
Alberto Bertogli
a7d49792f5 docs: Self-host the documentation
Instead of use readthedocs.org, point to the self-hosted version of the
rendered documentation.

We still use mkdocs to generate it, it's just more practical and
consistent to self-host the documentation.
2019-08-07 00:59:45 +01:00
Alberto Bertogli
c6c9866ae1 docs: Add documentation for security level checks
This patch adds documentation for the security level checks, and
references it (the rendered version, for convenience) from the README
file.
2019-08-06 03:05:43 +01:00
Alberto Bertogli
d348477841 docs: Integrate with readthedocs.org
This patch adds configuration to integrate with readthedocs.org, using
mkdocs as rendering engine.

It also does minor documentation updates, to tidy some things up
(clearer titles, move some documentation from the root into docs/, etc).
2019-08-05 14:30:14 +01:00
Alberto Bertogli
dade2041db README: Add link to the gitlab CI pipeline status
The integration tests are automatically run in a gitlab CI pipeline,
using docker.

This patch adds a link to the current status, like we do for the Go test
that are run in Travis, for convenience.
2019-07-14 00:26:19 +01:00
Alberto Bertogli
5d932b44a0 README: Update status and add line about main design target 2019-07-13 18:37:25 +01:00
Alberto Bertogli
ebad590c31 README: Remove codefresh.io integration
codefresh.io now requires to be logged in to view the status, and very
extensive permissions to even log in.

So I've removed the hook from the repository.
2018-09-27 00:14:49 +01:00
Alberto Bertogli
2dfed059e4 MTA-STS is now RFC 8461
MTA-STS has been published as RFC 8461, with no major changes since the
last draft we updated (-18).

This patch updates the documentation accordingly (no code changes).
2018-09-26 21:42:50 +01:00
Alberto Bertogli
2d1711ac47 README: Add MTA-STS reference 2018-07-14 10:08:27 +01:00
Alberto Bertogli
17b7bbe9c6 dovecot: Remove "experimental" qualifiers
dovecot support has been around for a release, has decent testing and
seems stable enough to remove the "experimental" qualifier.
2018-06-04 23:45:18 +01:00
Alberto Bertogli
97826d4f88 README: Match wording with website
Rewrite some of the paragraph to make them (hopefully) clearer, reorder
the feature list in a 2-level structure for more legibility, reference
the IRC channel, and other minor wording changes.
2018-05-20 12:05:32 +01:00
Alberto Bertogli
ead3e73c49 README: Add Codefresh badge
There is now a Codefresh CI pipeline which uses Docker to run the
integration tests. Link to it from the README for convenience.
2018-04-09 22:59:14 +01:00
Alberto Bertogli
4abffc9aaa docs: Minor link and wording fixes
Fix a link to letsencrypt in the how-to, and missing wording in the
readme.
2018-03-04 21:01:06 +00:00
Alberto Bertogli
40ae9b5f69 docs: Minor edits to the README file
This patch includes minor changes to the README file, such as small
rewordings, adding various links, and badges for convenience.
2018-03-03 14:04:21 +00:00
Alberto Bertogli
0f7fb6b8c7 docs: Split install instructions out of the README
To keep documentation more organized, this patch splits the install
instructions to its own file, and references it from the README file.
2018-03-02 19:56:17 +00:00
Alberto Bertogli
d39d3aaff4 chasquid: Dovecot support (experimental)
This patch adds dovecot support to the chasquid daemon, using the
internal dovecot library added in previous patches.

Dovecot support is still considered EXPERIMENTAL and may be reverted, or
changed in backwards-incompatible ways.

The patch also adds the corresponding integration test, which brings up
a dovecot server with a custom configuration, and tests chasquid's
authentication against it.  If dovecot is not installed, the test is
skipped.
2018-02-10 23:18:31 +00:00
Alberto Bertogli
b86463f123 README: Mention Debian and Ubuntu packages 2017-03-25 09:39:30 +00:00
Alberto Bertogli
df673c63fb README: Add missing code block
One of the command sequences was not indented enough, so it appears as
text instead of code.

This patch fixes that by surrounding it with ``` to mark it explicitly
as a code block.
2016-11-03 10:21:13 +00:00
Alberto Bertogli
2da74c1758 docs: Add some documentation and a README 2016-11-03 00:51:59 +00:00