# pterostatus
> A npm package meant for tracking your nodes
Latest version **2.0.0** (published 2021-08-29) · MIT license · 0 weekly downloads
## Install
```sh
npm install pterostatus
pnpm add pterostatus
yarn add pterostatus
bun add pterostatus
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-08-29 |
| First published | 2021-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 28.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 30 |
| Author | FlaringPhoenix |
| Maintainers | flaringphoenix |
## Links
- npm: https://www.npmjs.com/package/pterostatus
- Repository: https://github.com/FlaringPhoenix/Ptero-Status
- Homepage: https://github.com/FlaringPhoenix/Ptero-Status#readme
- Issues: https://github.com/FlaringPhoenix/Ptero-Status/issues
- npm.io page: https://npm.io/package/pterostatus
## Dependencies (9)
- [os](https://npm.io/package/os.md) ^0.1.1
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [discord.js](https://npm.io/package/discord.js.md) ^13.1.0
- [liquidcache](https://npm.io/package/liquidcache.md) ^1.0.0
- [systeminformation](https://npm.io/package/systeminformation.md) ^5.3.3
- [express-rate-limit](https://npm.io/package/express-rate-limit.md) ^5.2.5
## Recent versions
- 2.0.0 (latest) — 2021-08-29
- 1.1.3 — 2021-07-05
- 1.1.2 — 2021-03-26
- 1.1.1 — 2021-03-23
- 1.1.0 — 2021-03-02
- 1.0.9 — 2021-03-02
- 1.0.8 — 2021-03-02
- 1.0.7 — 2021-03-02
- 1.0.6 — 2021-03-01
- 1.0.5 — 2021-03-01
- 1.0.4 — 2021-02-26
- 1.0.3 — 2021-02-26
- 1.0.2 — 2021-02-26
## README
# Ptero-Status
    
# About
PteroStatus is an easy to setup [pterodactyl](https://github.com/pterodactyl/panel) daemon status project. It will continuously update a discord embed with live stats from your daemons.
## Preview
# Installation
Run the following command to install the npm package
```bash
npm i pterostatus
```
## Usage
### Node:
```javascript
const Status = require('pterostatus');
const Node = new Status.Node({
name: 'Node1',
interval: 15000,
controller: 'http://91.109.117.42:4000'
});
```
### Controller: (Simple)
```javascript
const Status = require('pterostatus');
const Controller = new Status.Controller({
port: 4000,
interval: 15000
});
```
### Controller: (Advanced)
```javascript
const Status = require('pterostatus');
const Controller = new Status.Controller(4000, {
discord: {
token: 'BOT-TOKEN',
channel: 'CHANNEL-ID',
},
pterodactyl: {
panel: 'https://panel.domain.com',
apiKey: 'API-KEY'
},
notifications: {
discord: process.env.DISCORD_WEBHOOK,
webhook: 'http://0.0.0.0:5000/webhook'
},
node: {
message: '**{node.name}**: [Memory: {node.memory.used}/{node.memory.total}] [Disk: {node.disk.used}/{node.disk.total}]',
online: '🟢 **ONLINE**',
offline: '🔴 **OFFLINE**'
},
embed: {
color: '#06cce2',
title: 'Node Status',
description: '**Nodes**:\n{nodes.list}\n\n**Total**:\nMemory: {memory.used}/{memory.total}\nDisk: {disk.used}/{disk.total}\n\n**Pterodactyl:**\nUsers: {pterodactyl.users}\nServers: {pterodactyl.servers}',
footer: {
text: 'Last updated: {lastupdated}',
icon: 'https://i.imgur.com/9b1qwml.jpg'
}
},
port: 4000,
interval: 15000
});
```
### Events
```javascript
Controller.on('online', (node) => {
console.log(`Node: "${node.nodeName}" has come back online!`);
});
Controller.on('offline', (node) => {
console.log(`Node: "${node.nodeName}" has gone offline!`);
});
```
### Pterodactyl Application API Key
You need to have pterodactyl panel installed in order to use PteroStatus' pterodactyl integration.
Not all permissions are required on the api key. Please just give the following permissions to the api key
### Placeholders:
**NODE**:
`{node.name}` - Node's name
`{node.memory.used}` - Total node's memory
`{node.memory.total}` - Total used memory
`{node.disk.used}` - Total used disk
`{node.disk.total}` - Total node's disk
`{node.cpu.used}` - Total used cpu
`{node.cpu.cores}` - Total cpu cores
`{node.cpu}` - Displays the cpu model
`{node.os}` - Displays the os
`{node.status}` - Shows if it's online or offline
**NODES**:
`{nodes.online}` - Number of online nodes
`{nodes.offline}` - Number of offline nodes
`{nodes.list}` - List of nodes along with their statuses
`{nodes.total}` - Number of total nodes
**TOTAL**:
`{memory.total}` - Total memory
`{disk.total}` - Total disk
`{cores.total}` - Total cores
**USED**:
`{memory.used}` - Total memory used by nodes
`{disk.used}` - Total disk used by nodes
`{memory.used%}` - Total memory percentage used by nodes
`{disk.used%}` - Total disk percentage used by nodes
**PTERODACTYL**:
`{pterodactyl.users}` - Number of current panel users
`{pterodactyl.servers}` - Number of current panel servers
# Support
Need some help setting up Ptero-Status?
Join BlueFox Development's Discord
> [https://discord.gg/KHbBfWSdnZ](https://discord.gg/KHbBfWSdnZ)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
---
_Source: https://npm.io/package/pterostatus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._