Linux API OS Infos

Powered by

---

📄 Purpose

REST Api to provide OS Linux infos like ram usage and cpu usage.

---

📖 Table of Contents

1. Purpose
2. Requirements
3. Install
   1. Import repository
   2. Install packages
4. Build
5. Run
   1. Hot run (development)
6. Docker
7. API Documentations
   1. Open API
   2. Vitals Mapping
8. Contributors

---

⚠️ Requirements

• Node 20.9.0
• NPM 10.1.0

⏬️ Install

Import repository

git clone https://github.com/IACA-Dev/linux-api-os-infos.git
cd linux-api-os-infos

Install packages

npm i

🛠️ Build

npm run build

Will generate dist directory.

▶️ Run

Hot run (development)

npm run start:dev

📦️ Docker

From Docker Hub (easy way)

docker run -e API_PORT=<port> --rm -p <port>:<port> iacaelectronique/linux-api-os-infos

Change port with your port.

Build

docker build --tag linux-api-os-infos .

You can change tag like you want.

Run

docker run -e API_PORT=<port> --rm -p <port>:<port> linux-api-os-infos

Change port with your port.

API Documentations

Open API

📋️ See open api description

Vitals Mapping

Id	Vital Name	Description
0	total ram	Total available RAM in bytes
1	used ram	Used RAM in bytes
2	cpu usage	CPU usage percentage

🧑‍🤝‍🧑 Contributors

• Julien FAURE ✉️ julien.faure@iaca-electronique.com (IACA Electronique)