serverio-rb

About

Track your home server status by simple API.

Methods

/api/v1/state

Will returns state of your server.

Call

$ curl -X GET 'host/api/v1/state'

Result

{
  "os": " Ubuntu 22.04.2 LTS",
  "arch": " x86-64",
  "host": "host",
  "kernel": "Kernel",
  "uptime": "up 5 days, 1 hour, 39 minutes"
}

How to use

You need Ruby and bundle for start.

1. Clone serverio-rb to your server:

$ git clone https://github.com/serverio-rb/serverio-rb

2. From serverio-rb directory run bundle to install dependencies:

$ bundle install

3. Run serverio-rb:

$ rackup --host 0.0.0.0 --port 9292

4. Go to serverio_rb_flutter for client or use curl (or alternatives) to track your server status.

How to contribute

Prepare project

Install dependencies:

$ bundle install

After that - make your features.

Check before commit

Read Commit Convention. Make sure your build is green before you contribute your pull request. Then:

$ bundle exec rake

If you don't see any error messages, submit your pull request.

Contributors

• @fartem as Artem Fomchenkov