V2 (Laravel re-make)
V2 (Laravel re-make)
This commit is contained in:
parent
d13e170f22
commit
e410eed97c
189
README.md
189
README.md
|
@ -1,42 +1,52 @@
|
||||||
# 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/) [![Generic badge](https://img.shields.io/badge/Bootstrap-5.1-pink.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) CRUD.
|
||||||
* Added save YABs to txt file constant
|
* Misc services CRUD.
|
||||||
* Updated domain attached to errors when null
|
* DNS CRUD.
|
||||||
* Updated getIpForDomain() call to echo (working now)
|
* Ip address CRUD.
|
||||||
* Updated `my_idlers.sql` for changes
|
* Reseller hosting.
|
||||||
|
* Added Operating systems to DB, Deleting and creating them now possible.
|
||||||
|
* Make servers displayable public with config options to hide certain values.
|
||||||
|
* Vue JS used where possible.
|
||||||
|
* Datatables used on large tables (Locations, labels, and providers).
|
||||||
|
* Added caching for home page and servers
|
||||||
|
|
||||||
## 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
|
||||||
* [Auto suggest locations](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-location.gif)
|
|
||||||
* [Auto suggest providers](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-auto-provider.gif)
|
|
||||||
* [Auto get IP's from hostname](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif)
|
* [Auto get IP's from hostname](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ips-from-hostname.gif)
|
||||||
* [Check up/down status](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif)
|
* [Check up/down status](https://cdn.write.corbpie.com/wp-content/uploads/2021/01/my-idlers-self-hosted-server-domain-information-ping-up-feature.gif)
|
||||||
* Get YABs data from output
|
* Get YABs data from output
|
||||||
|
@ -47,36 +57,101 @@ By using a [YABs](https://github.com/masonr/yet-another-bench-script) output you
|
||||||
* Multi currency compatibility
|
* Multi currency compatibility
|
||||||
* Multi payment-term compatibility
|
* Multi payment-term compatibility
|
||||||
* Pre-defined operating systems
|
* Pre-defined operating systems
|
||||||
* Assign tags
|
|
||||||
* Assign labels
|
* Assign labels
|
||||||
* Assign server type (KVM, OVZ, LXC & dedi)
|
* Assign server type (KVM, OVZ, LXC & dedi)
|
||||||
* Easy to edit values
|
* Easy to edit values
|
||||||
* Order by table
|
* Order by table
|
||||||
* Search items
|
|
||||||
* Tally/stats card
|
* Tally/stats card
|
||||||
* One-page design
|
|
||||||
|
|
||||||
## 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.
|
* `git clone https://github.com/cp6/my-idlers.git` into your directory of choice
|
||||||
* Run `my_idlers.sql` in MySQL.
|
* Run `composer install`
|
||||||
|
|
||||||
* **Only run ```update1.3to1.4.sql``` if you have version 1.3 installed.**
|
* Run `cp .env.example .env`
|
||||||
|
* Edit (If needed) MySQL details in .env
|
||||||
|
* Run `php artisan key:generate`
|
||||||
|
* Run `php artisan make:database my_idlers` to create database
|
||||||
|
* Run `php artisan migrate:fresh --seed` to create tables and seed data
|
||||||
|
* Run `php artisan serve`
|
||||||
|
|
||||||
* Edit ```class.php``` lines ```13-16``` for your MySQL details.
|
## API endpoints
|
||||||
* Edit ```class.php``` lines ```8-10``` for card order type.
|
|
||||||
|
|
||||||
* Make sure you have write access to process and store the YABs outputs.
|
For GET requests the header must have `Accept: application/json` and your API token (found at `/account`)
|
||||||
|
|
||||||
|
`Authorization : Bearer API_TOKEN_HERE`
|
||||||
|
|
||||||
|
All API requests must be appended with `api/` e.g `mydomain.com/api/servers/gYk8J0a7`
|
||||||
|
|
||||||
|
**GET request:**
|
||||||
|
|
||||||
|
`dns/`
|
||||||
|
|
||||||
|
`dns/{id}`
|
||||||
|
|
||||||
|
`domains/`
|
||||||
|
|
||||||
|
`domains/{id}`
|
||||||
|
|
||||||
|
`servers`
|
||||||
|
|
||||||
|
`servers/{id}`
|
||||||
|
|
||||||
|
`labels/`
|
||||||
|
|
||||||
|
`labels/{id}`
|
||||||
|
|
||||||
|
`locations/`
|
||||||
|
|
||||||
|
`locations/{id}`
|
||||||
|
|
||||||
|
`misc/`
|
||||||
|
|
||||||
|
`misc/{id}`
|
||||||
|
|
||||||
|
`networkSpeeds/`
|
||||||
|
|
||||||
|
`networkSpeeds/{id}`
|
||||||
|
|
||||||
|
`os/`
|
||||||
|
|
||||||
|
`os/{id}`
|
||||||
|
|
||||||
|
`pricing/`
|
||||||
|
|
||||||
|
`pricing/{id}`
|
||||||
|
|
||||||
|
`providers/`
|
||||||
|
|
||||||
|
`providers/{id}`
|
||||||
|
|
||||||
|
`reseller/`
|
||||||
|
|
||||||
|
`reseller/{id}`
|
||||||
|
|
||||||
|
`settings/`
|
||||||
|
|
||||||
|
`shared/`
|
||||||
|
|
||||||
|
`shared/{id}`
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
**There is no authentication provided!**
|
**Public viewable listings**
|
||||||
Either use on a local network or put behind authentication.
|
|
||||||
|
|
||||||
**Supporting YABS commands:**
|
If enabled the public viewable table for your server listings is at `/servers/public`
|
||||||
|
You can configure what you want viewable at ```/settings```
|
||||||
|
|
||||||
```curl -sL yabs.sh | bash```
|
**Due date / due soon**
|
||||||
|
|
||||||
|
This is simply just a reminder. If the homepage is requested (viewed) when a service is over due date it will get reset
|
||||||
|
to plus the term from the old due date.
|
||||||
|
|
||||||
|
E.g if the term is a month then the due date gets updated to be 1 month from the old due date.
|
||||||
|
|
||||||
|
**Supporting YABS commands:**
|
||||||
|
|
||||||
|
```curl -sL yabs.sh | bash```
|
||||||
|
|
||||||
or
|
or
|
||||||
|
|
||||||
|
@ -86,46 +161,26 @@ or
|
||||||
|
|
||||||
```# ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## #```
|
```# ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## #```
|
||||||
|
|
||||||
|
## Screenshots for v2
|
||||||
|
|
||||||
**A trimmed Bootstrap is used.** Only the used classes and elements are in ```style.css```
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-home.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-home.jpg)
|
||||||
Therefore adding more obscure columns or Bootstrap classes will not initially work as intended until you put this source 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
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-server-view.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-server-view.jpg)
|
||||||
and upon form submission it gets added to the pool to choose from next time.
|
|
||||||
|
|
||||||
### Screenshots
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-servers-home.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-servers-home.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-cards.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-cards.jpg)
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-YABs.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-YABs.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot2](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-table.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-table.jpg)
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-add-server.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-add-server.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot3](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-more-modal.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-more-modal.jpg)
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-servers-compare.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-servers-compare.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot4](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-edit-modal.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-edit-modal.jpg)
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-Ips.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-Ips.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot5](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-order-servers.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-order-servers.jpg)
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-labels.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-labels.jpg)
|
||||||
|
|
||||||
[![My idlers screenshot6](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-search.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-search.jpg)
|
##Looking for a project sponsor
|
||||||
|
|
||||||
[![My idlers screenshot7](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-summary-card.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-summary-card.jpg)
|
Am seeking atleast a 1GB ram, Nvme VPS to host a demo installation of My idlers. In return you will get your provider as the default selection in the create forms, as well as screenshots.
|
||||||
|
|
||||||
[![My idlers screenshot8](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-compare-two-servers.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-compare-two-servers.jpg)
|
|
||||||
|
|
||||||
[![My idlers screenshot9](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-add-server-from-yabs.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-add-server-from-yabs.jpg)
|
|
||||||
|
|
||||||
[![My idlers screenshot10](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-add-shared-hosting.jpg)](https://cdn.write.corbpie.com/wp-content/uploads/2021/02/my-idlers-self-hosted-server-info-add-shared-hosting.jpg)
|
|
||||||
|
|
||||||
[![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 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)
|
|
||||||
|
|
||||||
|
|
||||||
[![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)
|
|
||||||
|
|
||||||
|
[![My idlers screenshot1](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-default-provider-sponsor-position.png)](https://cdn.write.corbpie.com/wp-content/uploads/2022/03/My-idlers-v2-default-provider-sponsor-position.png)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user