swapnil/my-idlers
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source 
Updated readme
This commit is contained in:
cp6 2022-02-18 16:05:28 +11:00
parent e61e006b64
commit 8ce691d930
1 changed files with 43 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -1,37 +1,44 @@
# My idlers # My idlers
A web app for displaying, organizing and storing information about servers (VPS), shared hosting and domains. A web app for displaying, organizing and storing information about servers (VPS), shared & reseller hosting, domains,
DNS and misc services.
Despite what the name infers this self hosted web app isn't just for storing idling server information. By using
a [YABs](https://github.com/masonr/yet-another-bench-script) output you can get disk & network speed values along with
GeekBench 5 scores to do easier comparing and sorting.
## V2 notes ## V2 notes
V2 build is going to be a complete overhaul of My idlers with the project being moved onto the Laravel framework. This will simplyfy development and most of the features from the original build will be present in V2. V2 build is a complete overhaul of My idlers with the project being moved onto the Laravel framework. This will simplify
development and most of the features from the original build will be present in V2.
[Live demo](https://myidlers.srv3r.com/) Using Laravel will bring in an API endpoint and the possibilities to show servers publicly with certain parameters
removed.
Despite what the name infers this self hosted web app isn't just for storing idling server information. [Old version live demo](https://myidlers.srv3r.com/)
By using a [YABs](https://github.com/masonr/yet-another-bench-script) output you can get disk & network speed values along with GeekBench 5 scores to do easier comparing and sorting.
[![Generic badge](https://img.shields.io/badge/version-1.4-blue.svg)](https://shields.io/) [![Generic badge](https://img.shields.io/badge/version-2.0-blue.svg)](https://shields.io/) [![Generic badge](https://img.shields.io/badge/Laravel-9.0-red.svg)](https://shields.io/) [![Generic badge](https://img.shields.io/badge/PHP-8.1-purple.svg)](https://shields.io/)
## 1.4 changes: ## 2.0 changes:
**If you have version 1.3 already installed please run ```update1.3to1.4.sql```**
* Added compare servers section **Unfortunately you cannot migrate your current install to the new 2.0 version**
* Added ASN fetcher
* Added check for min version PHP 7.4 * Laravel framework (version 9)
* Added errors checks for YABs output inserting * Breeze authentication
* Added improved screenshots to readme * API GET for any of the CRUD data
* Updated delete YABs txt file when deleting server data * Labels (titles/desc) system
* Added save YABs to txt file constant * Misc services
* Updated domain attached to errors when null * DNS CRUD
* Updated getIpForDomain() call to echo (working now) * Make servers displayable public with config options to hide certain values.
* Updated `my_idlers.sql` for changes * Vue JS used where possible
## Requires ## Requires
* PHP 7.4 (compatible with 8.0) * PHP 8 (compatible with 8.1)
* MySQL * MySQL server
## Features ## Features
* Add servers * Add servers
* Add shared hosting * Add shared hosting
* Add domains * Add domains
@ -58,40 +65,40 @@ By using a [YABs](https://github.com/masonr/yet-another-bench-script) output you
## Install ## Install
* Download [the zip](https://github.com/cp6/my-idlers/archive/main.zip) and unpack the files from ```my-idlers-main/``` into your directory of choice. * Download [the zip](https://github.com/cp6/my-idlers/archive/main.zip) and unpack the files from ```my-idlers-main/```
into your directory of choice.
* Run `my_idlers.sql` in MySQL. * Run `my_idlers.sql` in MySQL.
* **Only run ```update1.3to1.4.sql``` if you have version 1.3 installed.** * **Only run ```update1.3to1.4.sql``` if you have version 1.3 installed.**
* Edit ```class.php``` lines ```13-16``` for your MySQL details. * Edit ```class.php``` lines ```13-16``` for your MySQL details.
* Edit ```class.php``` lines ```8-10``` for card order type. * Edit ```class.php``` lines ```8-10``` for card order type.
* Make sure you have write access to process and store the YABs outputs. * Make sure you have write access to process and store the YABs outputs.
## Notes ## Notes
**There is no authentication provided!** **There is no authentication provided!**
Either use on a local network or put behind authentication. Either use on a local network or put behind authentication.
**Supporting YABS commands:** **Supporting YABS commands:**
```curl -sL yabs.sh | bash``` ```curl -sL yabs.sh | bash```
or or
```curl -sL yabs.sh | bash -s -- -r``` ```curl -sL yabs.sh | bash -s -- -r```
**Make sure YABs output starts at the first line which is:** **Make sure YABs output starts at the first line which is:**
```# ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## #``` ```# ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## #```
**A trimmed Bootstrap is used.** Only the used classes and elements are in ```style.css```
**A trimmed Bootstrap is used.** Only the used classes and elements are in ```style.css``` Therefore adding more obscure columns or Bootstrap classes will not initially work as intended until you put this source
Therefore adding more obscure columns or Bootstrap classes will not initially work as intended until you put this source css into ```style.css```. css into ```style.css```.
**Auto complete provider & location are text inputs!** This means that if your choice isn't there then simply type it out **Auto complete provider & location are text inputs!** This means that if your choice isn't there then simply type it
and upon form submission it gets added to the pool to choose from next time. out and upon form submission it gets added to the pool to choose from next time.
### Screenshots ### Screenshots
@ -117,15 +124,11 @@ or
[![Auto complete location](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-location.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-location.gif) [![Auto complete location](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-location.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-location.gif)
[![Auto complete provider](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-provider.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-provider.gif) [![Auto complete provider](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-provider.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-provider.gif)
[![Auto complete IP's](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif) [![Auto complete IP's](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif)
[![Get up/down status](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif) [![Get up/down status](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif)
[![Table scrolling x](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-table-view.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-table-view.gif) [![Table scrolling x](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-table-view.gif)](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-table-view.gif)