diff --git a/README.md b/README.md index 588a4cd32..cb489b94c 100644 --- a/README.md +++ b/README.md @@ -1276,10 +1276,10 @@ SOFTWARE. [motioneye-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [motioneye-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [motioneye-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-phpmyadmin]: https://github.com/hassio-addons/addon-phpmyadmin/tree/6a7ebe6 -[addon-doc-phpmyadmin]: https://github.com/hassio-addons/addon-phpmyadmin/blob/6a7ebe6/README.md +[addon-phpmyadmin]: https://github.com/hassio-addons/addon-phpmyadmin/tree/ac24765 +[addon-doc-phpmyadmin]: https://github.com/hassio-addons/addon-phpmyadmin/blob/ac24765/README.md [phpmyadmin-issue]: https://github.com/hassio-addons/addon-phpmyadmin/issues -[phpmyadmin-version-shield]: https://img.shields.io/badge/version-6a7ebe6-blue.svg +[phpmyadmin-version-shield]: https://img.shields.io/badge/version-ac24765-blue.svg [phpmyadmin-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/phpmyadmin-armhf.svg [phpmyadmin-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [phpmyadmin-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/phpmyadmin/CHANGELOG.md b/phpmyadmin/CHANGELOG.md index 74a3335ca..a3a9d88f7 100644 --- a/phpmyadmin/CHANGELOG.md +++ b/phpmyadmin/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog since v0.1.2 +- ✏ Split add-on documentation - 🔨 Add php7-iconv (#14) - ⬆ Upgrades php7 to 7.3.18-r0 - ⬆ Upgrades mariadb-client to 10.4.13-r0 diff --git a/phpmyadmin/DOCS.md b/phpmyadmin/DOCS.md new file mode 100644 index 000000000..d000b8beb --- /dev/null +++ b/phpmyadmin/DOCS.md @@ -0,0 +1,126 @@ +# Home Assistant Community Add-on: phpMyAdmin + +phpMyAdmin is a database administration tool for MySQL & MariaDB. Frequently +used operations (managing databases, tables, columns, relations, indexes, +users, permissions, etc) can be performed via the user interface, +while you still have the ability to directly execute any SQL statement. + +This add-on was specifically designed to manage the official Home Assistant +MariaDB add-on. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "phpMyadmin" add-on in the Supervisor add-on store. +1. Install the "phpMyadmin" add-on. +1. Start the "phpMyAdmin" add-on. +1. Enjoy the add-on! + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +## Known issues and limitations + +- This add-on needs the core MariaDB add-on version 2.0 or higher. +- This add-on is created to allow management of the official Home assistant + MariaDB add-on. It cannot connect to other MySQL or MariaDB servers. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2020 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-phpmyadmin/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-phpmyadmin/171729?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-phpmyadmin/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-phpmyadmin/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/phpmyadmin/README.md b/phpmyadmin/README.md index ac3838e8f..fcb6f6c45 100644 --- a/phpmyadmin/README.md +++ b/phpmyadmin/README.md @@ -43,7 +43,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-phpmyadmin/blob/6a7ebe6/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-phpmyadmin/171729?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -52,6 +51,6 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-6a7ebe6-blue.svg -[release]: https://github.com/hassio-addons/addon-phpmyadmin/tree/6a7ebe6 +[release-shield]: https://img.shields.io/badge/version-ac24765-blue.svg +[release]: https://github.com/hassio-addons/addon-phpmyadmin/tree/ac24765 [screenshot]: https://github.com/hassio-addons/addon-phpmyadmin/raw/master/images/screenshot.png \ No newline at end of file diff --git a/phpmyadmin/config.json b/phpmyadmin/config.json index 69c9ecf67..3ba94c6e8 100644 --- a/phpmyadmin/config.json +++ b/phpmyadmin/config.json @@ -1,6 +1,6 @@ { "name": "phpMyAdmin", - "version": "6a7ebe6", + "version": "ac24765", "slug": "phpmyadmin", "description": "A web interface for the official MariaDB add-on", "url": "https://github.com/hassio-addons/addon-phpmyadmin",