lagdo / jaxon-adminer
Database management dashboard based on Jaxon and Adminer
Installs: 55
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 1
Type:application
Requires
- jaxon-php/jaxon-core: ^3.5
- jaxon-php/jaxon-dialogs: ^3.0
README
This package is deprecated. See the Jaxon DbAdmin package.
This package inserts a database admin dashboard into an existing PHP application. Thanks to the Jaxon library, it installs and runs in a page of the application. All its operations are performed with Ajax requests.
It is based on Adminer, so it will provide the same features. For example, it will be able to manage MySQL, PostgreSQL, Sqlite, MsSQL, MongoDb and Oracle databases.
Features
- Connect to a MySQL database.
- Show basic info about the MySQL database server.
- Show the list of tables in the connected database.
- Show detailed info about the MySQL database server.
- Show detailed info about the connected database.
- Connect to PostgreSQL databases.
- Restrict access to server info and databases.
- Execute requests and display results.
- Export databases to an sql file.
- Import databases from one or more sql files.
- Connect to other database types.
- Add others UI frameworks than Bootstrap, and let the user choose his preferred one (partially implemented, the user can choose between Bootstrap 3 and 4).
- Improve the Adminer code base (work in progress, see the https://github.com/lagdo/jaxon-adminer-drivers repo).
- Add tests
Howtos
This blog post on the Jaxon website explains how to install Jaxon Adminer on Voyager, an admin panel based on the Laravel framework: In english, and in french.
Documentation
Install the jaxon library so it bootstraps from a config file and handles ajax requests. Here's the documentation.
Install this package with Composer. If a Jaxon plugin exists for your framework, you can also install it. It will automate the previous step.
Declare the package and the database servers in the app section of the Jaxon configuration file.
'app' => [ // Other config options // ... 'packages' => [ Lagdo\Adminer\Package::class => [ 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], ], ], ], ],
Insert the CSS and javascript codes in the HTML pages of your application using calls to jaxon()->getCss() and jaxon()->getScript(true).
In the page that displays the dashboard, insert the HTML code returned by the call to jaxon()->package(\Lagdo\Adminer\Package::class)->getHtml(). Two cases are then possible.
-
If the dashboard is displayed on a dedicated page, make a call to
jaxon()->package(\Lagdo\Adminer\Package::class)->ready()in your PHP code when loading the page. -
If the dashboard is loaded with an Ajax request in a page already displayed, execute the javascript code returned the call to
jaxon()->package(\Lagdo\Adminer\Package::class)->getReadyScript()after the page is loaded.
Additional config options
There are other config options that can be used to customize Jaxon Adminer operation.
The default option sets a database server Jaxon Adminer must connect to when it starts.
'app' => [ 'packages' => [ Lagdo\Adminer\Package::class => [ 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], ], 'default' => 'second_server', ], ], ],
The access options restrict access only to databases or a defined set of databases on any server.
If the access.server is set to false at package level, then the access to all servers information will be forbidden.
The access.server option can also be set at a server level, and in this case it applies only to that specific server.
'app' => [ 'packages' => [ Lagdo\Adminer\Package::class => [ 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials 'access' => [ 'server' => true, ], ], ], 'default' => 'second_server', 'access' => [ 'server' => false, ], ], ], ],
In the above configuration, the user will be able to access server information only on the second_server.
The access.databases and access.schemas options define the set of databases and schemas the user can access.
This options can only be defined at server level, and will apply to that specific server.
'app' => [ 'packages' => [ Lagdo\Adminer\Package::class => [ 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials 'access' => [ 'server' => false, 'databases' => ['db1', 'db2', 'db3'], 'schemas' => ['public'], ], ], ], 'default' => 'second_server', ], ], ],
In the above configuration, the user will be able to get access only to three databases on the second_server, while he will have full access to the first_server.
Data import
SQL files can be uploaded and executed on a server. This feature is implemented using the Jaxon ajax upload feature, which then needs to be configured in the lib section of the Jaxon config file.
'lib' => [ 'upload' => [ 'files' => [ 'sql_files' => [ 'dir' => '/path/to/the/upload/dir', ], ], ], ],
As stated in the Jaxon ajax upload documentation, sql_files is the name attribute of the file upload field, and of course /path/to/the/upload/dir needs to be writable.
Other parameters can also be defined to limit the size of the uploaded files or retrict their extensions or mime types.
Data export
Databases can also be exported to various types of files: SQL, CSV, and more. A directory where the exported files are going to be saved must then be defined in the configuration, as well as an url where they can be downloaded.
'app' => [ 'packages' => [ Lagdo\Adminer\Package::class => [ 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials 'access' => [ 'server' => true, ], ], ], 'default' => 'second_server', 'access' => [ 'server' => false, ], 'export' => [ 'dir' => '/path/to/the/export/dir', 'url' => 'http://www.domain.com/exports', ], ], ], ],
The web server needs to be setup to serve the files in the dir from url.
Change the UI framework
Starting from version 0.6, this package is designed to support multiple UI frameworks, and multiple templates.
The current template is set using the template option, and it default value is bootstrap3.
'app' => [ 'packages' => [ Lagdo\Adminer\Package::class => [ 'template' => 'bootstrap3', 'servers' => [ 'first_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], 'second_server' => [ 'name' => '', // The name to be displayed in the dashboard UI 'driver' => '', // mysql, pgsql, sqlite, mongo, oracle, mssql or elastic. 'host' => '', // The database host name or address. 'port' => 0, // The database port 'username' => '', // The database user credentials 'password' => '', // The database user credentials ], ], ], ], ],
The following UI frameworks are supported:
- Bootstrap 3 (
bootstrap3) - Bootstrap 4 (
bootstrap4)
More UI frameworks will be added in future releases.
Contribute
- Issue Tracker: github.com/lagdo/jaxon-adminer/issues
- Source Code: github.com/lagdo/jaxon-adminer
License
The project is licensed under the Apache license.