nook24 / statusengine

New PHP based MySQL Backend for Naemon and Nagios 4 + responsive web frontend
https://statusengine.org/
GNU General Public License v2.0
16 stars 8 forks source link

Documented installation procedure doesn't include "users" table creation #37

Closed mjameswh closed 5 years ago

mjameswh commented 7 years ago

Following the documented installation procedure leads to statusengine's PHP interface complaining about non-existence of MySQL table "users". Structure of that table can be found in the source code (https://github.com/nook24/statusengine/blob/master/sql/statusengine.sql), but that file is not mentioned anywhere in documentation.

A closely related issue is that this file create a default admin user, with a hardcoded password hash, yet the actual password seems not to be documented anywhere. It seems that either the default password should be documented and users be advised to immediately change that default password, or the documentation should explain how to create the initial user (which might be difficult given that MySQL doesn't support blowfish encryption).

nook24 commented 7 years ago

Hi @mjameswh, good point. The installation of the interface is documented at: https://statusengine.org/interface.php#how-to-setup The users table gets created at point 4:

Create MySQL databases Statusengine: mysql -u root -p < sql/statusengine.sql

The default password is at the end of the documentation:

Navigate to http://xxx.xxx.xxx.xxx/statusengine with your favorite browser Username: admin Password: admin

Preview: This behavior will change, as soon as Statusengine 3 with the new Interface is released. With Statusengine 3 the default user is gone, and you need to create a user first, using the new CLI tools: bin/Console.php users add --username=admin --password=admin Run bin/Console.php users --help to get more information. You can also run the command without --username and --password to keep your password private and hidden from history.

At the moment I am write the new documentation, and rum some field tests with Statusengine 3. Take a look at https://statusengine.org/se3/ for news :)

mjameswh commented 7 years ago

Oh right, I missed that procedure, sorry for the noise ;)

Still, it seems somewhat unintuitive for one to know how to start from "I have a running Nagios/Naemon server" to "I have a fully functional Status Engine setup connected to it"... Pretty much everything seems to be written already, but knowing which procedure to follow in which order is more difficult. May I suggest that the "Getting Started" section on the home page give a more "hierarchical" view of the installation procedure? Something like:

Step 1. If not already done, install Nagios/Naemon... More details here (link to the Naemon installation procedure) Step 2. Install the Status Engine broker plugin for Nagios/Naemon... The procedure is here... Step 3. The Status Engine backend... Step 4. The Status Engine UI...

As for version 3, for sure I will give it a try as soon as I get some time... The page give me the impression though that it is still a long way to go before it is production ready. When do you expect to get it out?

nook24 commented 7 years ago

I like your idea, so I put this to the Statusengine 3 Getting Started page as Quick Start, maybe not the bast headline, don't know... se3_getting_started

With Statusengine 3 I try to restructure the whole project. For example I'am going to create a own GitHub Repository for all components. This first one is already online: https://github.com/statusengine/worker However I try to release the first version within a month. At the moment I need to tidy up the git repositories, remove unused files, and need to check how I can migrate this repository, that the contributors will not get lost.

Of course there is also a lot of documentation to write and I plan to create a few Video Tutorials to make it easier for beginners. :)

nook24 commented 7 years ago

@mjameswh two month passed since my last update about Statusengine 3... Birthday parties, Arduino and Steam Summer Sale came in the way. However, today I released the new version and updated the project page. More information is available in the Statusengine 3 - FAQ #41

nook24 commented 5 years ago

I will close this, because Statusengine 3 is available for more than a year now :)