Mikrus Buddy

Introduction

Mikrus Buddy is an open-source browser extension designed for the Mikrus community. This extension leverages the Mikr.us API to display vital information about your Mikrus VPS directly in your browser. Install from chrome webstore

Features

• VPS information: view detailed information about your VPS
  • server id
  • expiration date (both server and storage)
  • RAM and HDD size
  • Mikrus Pro status
  • uptime
  • Detailed RAM and HDD stats
• Server management:
  • restart your server with a single click
  • apply amphetamine to boost your RAM temporarily
• i18n: based on browser language. Supports:
  • Polish
  • English

Usage

Currently, the extension is available in the Chrome Web store only. Feel free to install it and rate here. All, you need to do next is to provide your API key and server ID. Both can be obtained from your mikr.us admin panel.

[!TIP] If you want to use this extension in a different browser, you need to build it by your own. See Building for different browsers for details

Permissions & API key safety

This extension needs just two permissions:

• storage - for storing user-entered data in the browser (API key, server ID)
• host permission - for making request to the official mikr.us API

[!NOTE] Your API key and server ID are sensitive information and cannot be shared with other users. Keeping that in mind, your data are not being sent anywhere but the official mikr.us API.

Roadmap

Look at the kanban board to see, what features are planned in the future.

Prerequisites

• Node.js
• npm

Development

1. Clone the repository:

   git clone https://github.com/iskrzycki/mikr.us-buddy.git
   cd mikr.us-buddy

2. Install dependencies:

   npm install

3. Running in a dev mode

   npm run dev

Building for different browsers

1. Build dist:

   # chrome
   npm run build
   # firefox
   npm run build:firefox

2. Create a zip bundle

   # chrome
   npm run zip
   # firefox
   npm run zip:firefox

3. Next, just load the extension bundle to your browser.

Different browser? Look at this guide for details.

License

This project is licensed under the MIT License.

Contact

For any questions or suggestions, feel free to open an issue or contact me at iskrzycki@gmail.com. If you find this project useful and would like to support its development, consider buying me a coffee.