Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lukasbecvar/admin-suite

Solution for Linux server administration and monitoring.
https://github.com/lukasbecvar/admin-suite

admin database linux monitoring php symfony tool

Last synced: about 1 month ago
JSON representation

Solution for Linux server administration and monitoring.

Awesome Lists containing this project

README 

        
# 
Admin suite


### 
Solution for administration and monitoring linux private servers




    License |

    Author




## Dashboard preview

![Dashboard](.github/assets/preview.png)



## Code base

This project is based on the Symfony framework. The entire project is designed to require as few dependencies and additional software as possible for easy installation and maintenance.



## Primary use

I created this project to manage my personal servers. I wanted a simple and easy-to-use solution that would allow me to monitor and manage my servers without relying on complex software or complicated setups. This project aims to manage single server instances, not clusters.



## Installation

Installation is very simple like any other PHP project.

* Clone repo ``git clone [email protected]:lukasbecvar/admin-suite.git``

* Create apache virtual host or nginx configuration like ([apache-config](https://github.com/lukasbecvar/admin-suite/blob/main/.docker/configs/apache-site.conf))

* Create .env file with your configuration (.env.prod)

* Create admin suite database

* Run database migrations (script/migrate.sh)

* Create user with console command or web interface (webinterface allows to create user if users table is empty)



## Configuration

* You can edit the config files directly in config/suite but it is better to create your own in the project root because these files will be loaded primarily and ignored by git when using the pull for update with scripts/upgrade.sh

* Configure your package-requitements.json & services.json in root file (for example use config/suite files)

* Create systemd or screen service for monitoring process (console command infinite loop) ([systemd-config](https://github.com/lukasbecvar/admin-suite/blob/main/.docker/configs/monitoring-systemd.service))



## Exception monitoring

In config exception-files.json it is possible to set paths to exception files and track exceptions from your applications via log manager



## External log API

* ``/api/external/log`` - POST (data: name, message, level)

* The external log API is used for retrieving logs from external services. External API log is in the .env configuration file.



## Monitoring

Monitoring is ensured by a console command (infinite loop) ``console app:process:monitoring``. This command needs to be run as a service, and the monitored services should be defined in the services file in the root of the project, which is considered the primary source, or directly in config/suite/services.json. it is necessary to set the monitoring interval and the SMTP server in the environment variables for sending alerts. The status and monitoring data can then be viewed on the web dashboard. 



## Authentication

Authentication uses a completely custom user system with only a username and password, and all users are managed by the application administrator. Only the first user can use the registration to create the first user in the database. The login using a standard PHP session and a cookie for the 'remember me'.



## Requirements

* OS Linux

* PHP 8.3

* MySQL 8

* Mysql - PDO driver

* PHP-OpenSSL extension

* PHP-Intl extension

* PHP-Curl extension

* Composer

* NPM package manager and assets build tool for encore build



## Development environment

The complete stack for development is in Docker Compose, including PHP, Node, and Composer. You just need to run the docker-start script to launch it.



## Contributing

Contributions are welcome! Please fork this repository and submit pull requests for any features, bug fixes, or enhancements. If you have any questions or need help, feel free to open an issue or contact me directly.



## Dependencies

This project uses the following technologies

* PHP

    * [Website](https://php.net)

* Symfony with doctrine

    * [Website](https://symfony.com)

* PHPUnit

    * [Github](https://github.com/sebastianbergmann/phpunit)

* Sempro-PHPUnit-Pretty-Print

    * [Github](https://github.com/sempro/phpunit-pretty-print)

* PHPStan

    * [Github](https://github.com/phpstan/phpstan)

* Tailwind

    * [Website](https://tailwindcss.com)

* HighlightJS

    * [Website](https://highlightjs.org)

* NPM / Webpack encore

    * [NPM](https://docs.npmjs.com)

    * [Encore](https://symfony.com/doc/current/frontend/encore/index.html)



## License

This software is licensed under the [MIT license](https://github.com/lukasbecvar/admin-suite/blob/main/LICENSE).