Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bserem committed Mar 22, 2022
1 parent d2e02bf commit 37fd251
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,38 @@

This repository allows you to quickly install Adminer database manager into a [Ddev](https://ddev.readthedocs.io) project using just `ddev get bserem/ddev-adminer`.

Adminer (formerly phpMinAdmin) is a full-featured database management tool written in PHP. **Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, Oracle, Elasticsearch, MongoDB, SimpleDB ([plugin](https://raw.githubusercontent.com/vrana/adminer/master/plugins/drivers/simpledb.php)), Firebird ([plugin](https://raw.githubusercontent.com/vrana/adminer/master/plugins/drivers/firebird.php)), ClickHouse ([plugin](https://raw.githubusercontent.com/vrana/adminer/master/plugins/drivers/clickhouse.php)).**
Adminer is a full-featured database management tool written in PHP. This service
currently ships the [official adminer container](https://hub.docker.com/_/adminer)
with no _external_ plugins. It contains all official plugins and themes and allows
to easily chose one by editing the `docker-compose.adminer.yaml` file after
installation.

This service currently ships the default adminer package with no _external_ plugins. It contains all official plugins and themes and allows to easily chose one by editing the `docker-compose.adminer.yaml` file after installation.
The official container supports:

* MySQL / MariaDB
* PostgreSQL
* SQLite
* SimpleDB
* Elasticsearch

## Why?

Because you might need something other than MySQL / MariaDB in your DDEV project. We got you covered.

## Installation

* `ddev get bserem/ddev-adminer && ddev restart`

## Caveats
* You need to pass database credentials manually for the time being. If you have any ideas on how to overcome this issue please let me know. **Default ddev database credentials are: user `db`, pass `db`, database `db`.**

You need to pass database credentials manually for the time being. If you have
any ideas on how to overcome this issue please let me know.

Default ddev database credentials are:

* user `db`
* password `db`
* database `db`

---
**Contributed and maintained by [@bserem](https://github.com/bserem).**

0 comments on commit 37fd251

Please sign in to comment.