stalwartlabs / website

Stalwart Documentation and Website

Stalwart Website Documentation

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

website's Issues

FoundationDB instructions on installation page

I went through the installation, chose FoundationDB as my backend, and was confused about why I was seeing Stalwart crash.

It wasn't until I installed FoundationDB that the issues stopped.

Broken link

Hi.

On the website, I found a page with a dead link - https://stalw.art/docs/server/fail2ban/ . I found that page via the search functionality with "fail2ban" input. I think it should be fixed. Probably, there are more broken links in the documentation - we need to recheck it as well.

Document password reset

Hi,

In my notes I have

🔑 The administrator account is 'admin' with password 'Str1ngFr0mInst@ll3r'.

However:

$ stalwart-cli -u https://127.0.0.1:8080 -c Str1ngFr0mInst@ll3r report list
Failed to deserialize response: EOF while parsing a value at line 1 column 0
$ stalwart-cli -u https://127.0.0.1:8080 -c OTHERPASSWORD report list
Failed to deserialize response: EOF while parsing a value at line 1 column 0
$

How to reset the password?

FWIW: Pasting that knowledge here, makes it possible for others to add to website.

Is there documentation on which projects are production-ready?

I believe all of the servers are not version 1.0.0 or higher yet. Does this mean that they are not suitable for hosting real email yet? What does this lower version entail?

LDAP documentation improvement

Stalwart offers this integration in a flexible manner and it is already great.

The documentation offers to rely on PosixAccount and PosixGroup object classes but this doesn't fill well
with my needs.

Unfortunately stardadized LDAP objects are not handling properly the specific needs of a MTA while offering some mail related fields, that shoud be used for identity rather than for the MTA user profile and accesses.

We can see also a lot of schema published arond various MTA, but there is no standardized schema with a RFC.

It exist however a few IETF drafts that attempt to solve the issue

https://tools.ietf.org/html/draft-srivastava-ldap-mail-00
https://tools.ietf.org/html/draft-lachman-ldap-mail-routing-03
https://tools.ietf.org/html/draft-steinback-ldap-mailgroups-00

and a LDAP schema published by debops that implements them under an unified OID

https://github.com/debops/debops/blob/master/ansible/roles/slapd/files/etc/ldap/schema/debops/mailservice.schema

I'll be willing to lead some PR's (mostly doc and some code here and there) that publish a stalwart specific schema extension, offering a clear and smooth LDAP integration and setup assistant.

For it to be well done in the state of the art, I will need to use a specific OID identification number that is standardized and contains a IANA that is registered for the entity publishing the shema.
Unfortunately, as far as i know, there is no stalwart IANA PEN number registered.
https://www.iana.org/assignments/enterprise-numbers/?q=stalwart

The registration is quite straightforward and would allow to offer the system admisitrator a dedicated schema for the stalwart user database and configuration.

https://www.iana.org/assignments/enterprise-numbers/assignment/apply/

Please let me know if you're interressed in such a contribution, amd if so, to apply stalwart for a IANA number.

Best regards

postmaster inbox / auto-dmarc location?

I'm curious if it's possible for there to be an address just read by stalwart for the dmarc reports, that deletes the emails after it's gotten the report info / after a certain amount of time. Maybe with some disclaimer when it detects a non-dmarc email that the inbox isn't monitored (but that could lead to an infinite loop).

Right now those go to the catch-all email address.

Documentation

Hello,

I'm currently trying to set up stalwart. The documentation is basically very good at explaining the options thank you for that! However, I'm missing which file I would add the config to. For example: https://stalw.art/docs/directory/types/sql#connection-string. Is this for the mail or the SMTP-backend?

Actually, I realized now that I have installed stalwart twice once only SMTP and once the full package. But still when having installed the full package there are many configuration files which one would be the opinionated best one for the configurations

Wish: Describe _manual install_

Currently at https://stalw.art/docs/install/linux/

Please note that root access is required to perform the installation, if you don't feel comfortable running the install script as root you may also download the stalwart-install binary and perform a manual installation.

But how to perform the manual install of "stallwart"?

(I will use this issue to document my install journey.)

sieve.info domain taken over

The site no longer points to the documentation and presents an invalid certificate on connection.

https://archive.is/ZMimA

The HTTP link works fine http://sieve.info

This page/doc need semantic versioning too

I'm use the Stawart in production, and i need access to specific version of documentation for troubleshoot. But this doc/site reflect latest version and in my production, I'm use specifc version. You could use versioning for the static site, I keep accessing the documentation through commits, and that's not good at all.

Typo in protocol=https?

The documentation states that https is a valid protocol:
https://github.com/stalwartlabs/website/blame/0bc37a769dd140d2036b12e592fc5f1855899c9b/docs/server/listener.md#L34

But the examples below mention http.
https://github.com/stalwartlabs/website/blame/0bc37a769dd140d2036b12e592fc5f1855899c9b/docs/server/listener.md#L126

Which one is correct?

Update Caddy docs

Someone in our community noted that the Caddy docs on Stalwart's website were a bit old or unclear/inaccurate.

I am not a Stalwart user but wanted to check if Stalwart does in fact use HTTP? The suggested Caddyfiles proxy HTTP, not raw TCP.

Also, Caddy does support the PROXY protocol as of a while ago: https://caddyserver.com/docs/caddyfile/directives/reverse_proxy#proxy_protocol

For proxying TCP, there's a layer 4 plugin that does this: https://github.com/mholt/caddy-l4

And instead of copying certs with a cron job, Caddy has an eventing system that can be utilized more appropriately. For example: https://github.com/mholt/caddy-events-exec (formal documentation is still forthcoming so it's understandable that this was missed; it's also new).