# ftp-user-manager

> FTP User Manager is a Node.js package for managing FTP users on a remote server via SSH.

Latest version **1.0.4** (published 2024-03-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install ftp-user-manager
pnpm add ftp-user-manager
yarn add ftp-user-manager
bun add ftp-user-manager
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2024-03-26 |
| First published | 2024-03-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | sanchit-sherawat |
| Maintainers | sanchitsherawat |
| Keywords | ftp, user-management, ssh, remote, server, administration, system, utility, nodejs |

## Links

- npm: https://www.npmjs.com/package/ftp-user-manager
- Repository: https://github.com/sanchit-sherawat/ftp-user-manager
- Homepage: https://github.com/sanchit-sherawat/ftp-user-manager#readme
- Issues: https://github.com/sanchit-sherawat/ftp-user-manager/issues
- npm.io page: https://npm.io/package/ftp-user-manager

## Dependencies (1)

- [ssh2](https://npm.io/package/ssh2.md) ^1.15.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2024-03-26
- 1.0.3 — 2024-03-26
- 1.0.2 — 2024-03-26
- 1.0.1 — 2024-03-26
- 1.0.0 — 2024-03-26

## README

## FTP User Manager
FTP User Manager is a Node.js package for managing FTP users on a remote server via SSH.

# Features
- Create new FTP users
- Update passwords for existing FTP users
- Delete FTP users
# Installation
- You can install the FTP User Manager package via npm:

```bash
Copy code
npm install ftp-user-manager
Usage
javascript
Copy code
const { createUser, updateUser, deleteUser } = require('ftp-user-manager');

// SSH configuration
const sshConfig = {
    host: 'your-ssh-host',
    port: 22,
    username: 'your-ssh-username',
    privateKey: require('fs').readFileSync('/path/to/private-key.pem')
};

// Create a new FTP user
createUser(sshConfig, 'newuser', 'password123')
    .then(result => console.log(result))
    .catch(error => console.error(error));

// Update password for an existing FTP user
updateUser(sshConfig, 'existinguser', 'newpassword456')
    .then(result => console.log(result))
    .catch(error => console.error(error));

// Delete an existing FTP user
deleteUser(sshConfig, 'existinguser')
    .then(result => console.log(result))
    .catch(error => console.error(error));
```
# License
- This project is licensed under the MIT License - see the LICENSE file for details.

- A just the SSH configuration and usage examples according to your package's requirements. Include any additional information or usage examples that you think would be helpful for users. Make sure to also provide information about installation, dependencies, and any other relevant details about your package.

- You can further enhance your README with sections like:

# Introduction
- Installation instructions (including prerequisites)
- Configuration
- Examples
# API documentation
- Contribution guidelines

- Testing instructions
- Troubleshooting
- Support/contact information

---
_Source: https://npm.io/package/ftp-user-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._