Add decommission note
This commit is contained in:
parent
b86c493e7b
commit
8ffd0bc9c1
91
README.md
91
README.md
|
@ -1,71 +1,34 @@
|
|||
# LDAPjs
|
||||
# Project Decomissioned
|
||||
|
||||
[![Build Status](https://github.com/ldapjs/node-ldapjs/workflows/Lint%20And%20Test/badge.svg)](https://github.com/ldapjs/node-ldapjs/actions)
|
||||
[![Coverage Status](https://coveralls.io/repos/github/ldapjs/node-ldapjs/badge.svg)](https://coveralls.io/github/ldapjs/node-ldapjs/)
|
||||
This project has been decomissioned. I, James Sumners, took it on when it was
|
||||
languishing without any maintenance as it filled a need in the ecosystem and
|
||||
I had built things at a prior organization that depended upon this project.
|
||||
I spent a lot of time triaging issues and reworking things toward a path
|
||||
that could be more easily maintained by a community of volunteers. But I have
|
||||
not had the time to dedicate to this project in quite a while. There are
|
||||
outstanding issues that would take me at least a week of dedicated development
|
||||
time to solve, and I cannot afford to take time off of work to do that.
|
||||
Particularly considering that the aforementioned organization was two
|
||||
jobs ago, and it is extremely unlikely that I will transition to a role again
|
||||
that will need this project.
|
||||
|
||||
LDAPjs makes the LDAP protocol a first class citizen in Node.js.
|
||||
So, why am I just now deciding to decomission this project? Because today,
|
||||
2024-05-14, I received the following email:
|
||||
|
||||
## Usage
|
||||
![Abusive email](dt.png)
|
||||
|
||||
For full docs, head on over to <http://ldapjs.org>.
|
||||
I will not tolerate abuse, and I especially will not tolerate tacit death
|
||||
threats, over a hobby. You can thank the author of that email for the
|
||||
decomissioning on this project.
|
||||
|
||||
```javascript
|
||||
var ldap = require('ldapjs');
|
||||
My recommendation to you in regard to LDAP operations: write a gateway in a
|
||||
language that is more suited to these types of operations. I'd suggest
|
||||
[Go](https://go.dev).
|
||||
|
||||
var server = ldap.createServer();
|
||||
👋
|
||||
|
||||
server.search('dc=example', function(req, res, next) {
|
||||
var obj = {
|
||||
dn: req.dn.toString(),
|
||||
attributes: {
|
||||
objectclass: ['organization', 'top'],
|
||||
o: 'example'
|
||||
}
|
||||
};
|
||||
|
||||
if (req.filter.matches(obj.attributes))
|
||||
res.send(obj);
|
||||
|
||||
res.end();
|
||||
});
|
||||
|
||||
server.listen(1389, function() {
|
||||
console.log('ldapjs listening at ' + server.url);
|
||||
});
|
||||
```
|
||||
|
||||
To run that, assuming you've got the [OpenLDAP](http://www.openldap.org/)
|
||||
client on your system:
|
||||
|
||||
ldapsearch -H ldap://localhost:1389 -x -b dc=example objectclass=*
|
||||
|
||||
## Installation
|
||||
|
||||
npm install ldapjs
|
||||
|
||||
## Node.js Version Support
|
||||
|
||||
As of `ldapjs@3` we only support the active Node.js LTS releases.
|
||||
See [https://github.com/nodejs/release#release-schedule][schedule] for the LTS
|
||||
release schedule.
|
||||
|
||||
For a definitive list of Node.js version we support, see the version matrix
|
||||
we test against in our [CI configuration][ci-config].
|
||||
|
||||
Note: given the release date of `ldapjs@3`, and the short window of time that
|
||||
Node.js v14 had remaining on its LTS window, we opted to not support Node.js
|
||||
v14 with `ldapjs@3` (we released late February 2023 and v14 goes into
|
||||
maintenance in late April 2023). Also, Node.js v14 will be end-of-life (EOL) on
|
||||
September 11, 2023; this is a very shortened EOL timeline and makes it even
|
||||
more reasonable to not support it at this point.
|
||||
|
||||
[schedule]: https://github.com/nodejs/release#release-schedule
|
||||
[ci-config]: https://github.com/ldapjs/node-ldapjs/blob/master/.github/workflows/main.yml
|
||||
|
||||
## License
|
||||
|
||||
MIT.
|
||||
|
||||
## Bugs
|
||||
|
||||
See <https://github.com/ldapjs/node-ldapjs/issues>.
|
||||
P.S.: if I ever do need this project again, I might revive it. But I'd fight
|
||||
hard for my suggestion above. Also, I will consider turning it over to an
|
||||
interested party, but I will require at least one recommendation from a
|
||||
Node.js core contributor that I can vet with the people that I know on that
|
||||
team.
|
Loading…
Reference in New Issue