Skip to content

Conversation

@ccclxxiii
Copy link
Contributor

@ccclxxiii ccclxxiii commented Jan 2, 2026

pr overview:

  • based on conversations in mutual help channel, an operator needed to understand how to migrate from desktop to laptop for their control machine
  • it was discovered that it was not clear nor documented on the procedures and likely was not tested
  • this pr updates the relay documentation to demonstrate how to migrate the control machine
  • the instructions have been tested on a working relay

note to team:

  • maddy_chatmail is 404 causing ci to fail on tests, remove it for now.

@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 2, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging2.testrun.org January 2, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging-ipv4.testrun.org January 2, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii requested review from feld and link2xt January 2, 2026 13:20
Copy link
Contributor

@adbenitez adbenitez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good but I didn't know what a "control machine" is maybe add a note "control machine (the computer from where you run the server deployment script and upgrades)" or something like that

Copy link
Contributor

@hpk42 hpk42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think a full new doc is required for migrating the client machine. It's basically about having to preserve chatmail.ini and www-customizations.

So I think the content could be condensed e.g. into a last new section in https://chatmail.at/doc/relay/getting_started.html

sidenote: i am wondering about the term "control" machine -- but don't yet have better suggestion.

Copy link
Contributor

@hpk42 hpk42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think a full new doc is required for migrating the client machine. It's basically about having to preserve chatmail.ini and www-customizations.

So I think the content could be condensed e.g. into a last new section in https://chatmail.at/doc/relay/getting_started.html

sidenote: i am wondering about the term "control" machine -- but don't yet have better suggestion.

@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 3, 2026 18:44 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging-ipv4.testrun.org January 3, 2026 18:44 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging2.testrun.org January 3, 2026 18:44 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii requested a review from hpk42 January 3, 2026 18:44
@ccclxxiii
Copy link
Contributor Author

i don't think a full new doc is required for migrating the client machine. It's basically about having to preserve chatmail.ini and www-customizations.

So I think the content could be condensed e.g. into a last new section in https://chatmail.at/doc/relay/getting_started.html

i'll look at condensing it.

sidenote: i am wondering about the term "control" machine -- but don't yet have better suggestion.

it's typically a term i've used when i have to orchestrate from a machine to servers. i can adjust it if needed

@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 3, 2026 19:02 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging2.testrun.org January 3, 2026 19:02 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging-ipv4.testrun.org January 3, 2026 19:02 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii had a problem deploying to staging-ipv4.testrun.org January 3, 2026 19:03 — with GitHub Actions Error
@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 3, 2026 19:03 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 3, 2026 19:04 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging2.testrun.org January 3, 2026 19:04 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging-ipv4.testrun.org January 3, 2026 19:04 — with GitHub Actions Inactive
@ccclxxiii
Copy link
Contributor Author

@hpk42 change requests are complete. let me know if there's further revisions.

- `Maddy-Chatmail <https://github.com/sadraiiali/maddy_chatmail>`_: a
plugin for the `Maddy email server <https://maddy.email/>`_ which
aims to implement the chatmail relay features and configuration
options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that looks a bit unrelated -- what is the background of this removal?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hpk42 i had mentioned it in the initial overview. the link for github is 404 and it caused ci to fail, so it was removed to push it forward. if you like i can add it back.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/omidz4t/madmail is the new location.

@ccclxxiii ccclxxiii requested a review from hpk42 January 3, 2026 21:54
Copy link
Contributor

@hpk42 hpk42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the madmail project is the official successor of the maddy-plugin approach, so i suggest to add this, while remopving stale maddy-chatmail reference.

- `Maddy-Chatmail <https://github.com/sadraiiali/maddy_chatmail>`_: a
plugin for the `Maddy email server <https://maddy.email/>`_ which
aims to implement the chatmail relay features and configuration
options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/omidz4t/madmail is the new location.

@ccclxxiii ccclxxiii temporarily deployed to staging.chatmail.at/doc/relay/ January 4, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging2.testrun.org January 4, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii temporarily deployed to staging-ipv4.testrun.org January 4, 2026 13:11 — with GitHub Actions Inactive
@ccclxxiii ccclxxiii had a problem deploying to staging-ipv4.testrun.org January 4, 2026 13:20 — with GitHub Actions Error
@hpk42 hpk42 merged commit d1f9523 into main Jan 4, 2026
5 of 7 checks passed
@hpk42 hpk42 deleted the 373/document-migrating-control-system branch January 4, 2026 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants