Skip to content

chore: prettify README.md #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 32 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,56 @@

**MX server management for iojs.org**


## Server

[Mailgun](http://www.mailgun.com/) is used to route email from the `iojs.org` domain to the aliases described in this repo.

[Mailgun](http://www.mailgun.com/) is used to route email from the `iojs.org`
domain to the aliases described in this repo.

## Email aliases

The [iojs.org](./iojs.org) directory contains the [aliases.json](./iojs.org/aliases.json) file which describes the wanted email aliasing. It is structured as a mapping of `"from"` usernames @iojs.org to `"to"` actual email addresses.

The [iojs.org](./iojs.org) directory contains the
[`aliases.json`](./iojs.org/aliases.json) file which describes the wanted email
aliasing. It is structured as a mapping of `"from"` usernames @iojs.org to
`"to"` actual email addresses.

## Updating

### Responsibility

Since access to the Mailgun API key is required, only members of the @nodejs/build-infra team have the permission to push code to the `main` branch. That was done in order to minimize the possibility of mismatches between the information in this repo, and the actual email routes that are set up.
Since access to the Mailgun API key is required, only members of the
@nodejs/build-infra team have the permission to push code to the `main` branch.
That was done in order to minimize the possibility of mismatches between the
information in this repo, and the actual email routes that are set up.

### Procedure

The [update](./update) directory contains a node program which will read the aliases mapping file, fetch the list of mail routes from Mailgun and update the routes to make sure they match the required state. The program is run by passing it a domain name as an argument (`update/update.js iojs.org`).
The [`update/`](./update) directory contains a node program which will read the
aliases mapping file, fetch the list of mail routes from Mailgun and update the
routes to make sure they match the required state. The program is run by passing
it a domain name as an argument (`update/update.js iojs.org`).

The Mailgun API key for the given domain is required. It can be found in the `admin_logins.md` file in the secrets repo (build/infra/), or directly via the Rackspace API. The key should be stored as a file named `iojs.org/credentials.json` in the form: `{ "api-key": "key-abc..." }` within a code tree.

The programs can be used with `--dry-run` to verify the current status and what will be changed by an update.
The Mailgun API key for the given domain is required. It can be found in the
`admin_logins.md` file in the secrets repo (build/infra/), or directly via the
Rackspace API. The key should be stored as a file named
`iojs.org/credentials.json` in the form: `{ "api-key": "key-abc..." }` within a
code tree.

The programs can be used with `--dry-run` to verify the current status and what
will be changed by an update.

## nodejs.org

`@nodejs.org` email addresses are managed by the Linux Foundation. In order to set one up:
* Create an iojs.org alias with associated recipients as described above.
* Send an email to '[email protected]' requesting that the wanted nodejs.org address by directed to the new alias. Please CC an OpenJS Foundation contact person and provide context as to why the alias is needed.
`@nodejs.org` email addresses are managed by the Linux Foundation. In order to
set one up:

## License & copyright
- Create an iojs.org alias with associated recipients as described above.
- Send an email to <[email protected]> requesting that the wanted
nodejs.org address by directed to the new alias. Please CC an OpenJS
Foundation contact person and provide context as to why the alias is needed.

The contents of this repository are Copyright (c) Node.js Foundation and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.
## License & copyright

The contents of this repository are Copyright (c) Node.js Foundation and
licensed under the MIT licence. All rights not explicitly granted in the MIT
license are reserved. See the included [`LICENSE.md`](./LICENSE.md) file for
more details.