|
| 1 | +# Home Assistant Community Add-on: phpMyAdmin |
| 2 | + |
| 3 | +phpMyAdmin is a database administration tool for MySQL & MariaDB. Frequently |
| 4 | +used operations (managing databases, tables, columns, relations, indexes, |
| 5 | +users, permissions, etc) can be performed via the user interface, |
| 6 | +while you still have the ability to directly execute any SQL statement. |
| 7 | + |
| 8 | +This add-on was specifically designed to manage the official Home Assistant |
| 9 | +MariaDB add-on. |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +The installation of this add-on is pretty straightforward and not different in |
| 14 | +comparison to installing any other Home Assistant add-on. |
| 15 | + |
| 16 | +1. Search for the "phpMyadmin" add-on in the Supervisor add-on store. |
| 17 | +1. Install the "phpMyadmin" add-on. |
| 18 | +1. Start the "phpMyAdmin" add-on. |
| 19 | +1. Enjoy the add-on! |
| 20 | + |
| 21 | +## Configuration |
| 22 | + |
| 23 | +**Note**: _Remember to restart the add-on when the configuration is changed._ |
| 24 | + |
| 25 | +Example add-on configuration: |
| 26 | + |
| 27 | +```yaml |
| 28 | +log_level: info |
| 29 | +``` |
| 30 | +
|
| 31 | +**Note**: _This is just an example, don't copy and paste it! Create your own!_ |
| 32 | +
|
| 33 | +### Option: `log_level` |
| 34 | + |
| 35 | +The `log_level` option controls the level of log output by the addon and can |
| 36 | +be changed to be more or less verbose, which might be useful when you are |
| 37 | +dealing with an unknown issue. Possible values are: |
| 38 | + |
| 39 | +- `trace`: Show every detail, like all called internal functions. |
| 40 | +- `debug`: Shows detailed debug information. |
| 41 | +- `info`: Normal (usually) interesting events. |
| 42 | +- `warning`: Exceptional occurrences that are not errors. |
| 43 | +- `error`: Runtime errors that do not require immediate action. |
| 44 | +- `fatal`: Something went terribly wrong. Add-on becomes unusable. |
| 45 | + |
| 46 | +Please note that each level automatically includes log messages from a |
| 47 | +more severe level, e.g., `debug` also shows `info` messages. By default, |
| 48 | +the `log_level` is set to `info`, which is the recommended setting unless |
| 49 | +you are troubleshooting. |
| 50 | + |
| 51 | +## Known issues and limitations |
| 52 | + |
| 53 | +- This add-on needs the core MariaDB add-on version 2.0 or higher. |
| 54 | +- This add-on is created to allow management of the official Home assistant |
| 55 | + MariaDB add-on. It cannot connect to other MySQL or MariaDB servers. |
| 56 | + |
| 57 | +## Changelog & Releases |
| 58 | + |
| 59 | +This repository keeps a change log using [GitHub's releases][releases] |
| 60 | +functionality. The format of the log is based on |
| 61 | +[Keep a Changelog][keepchangelog]. |
| 62 | + |
| 63 | +Releases are based on [Semantic Versioning][semver], and use the format |
| 64 | +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented |
| 65 | +based on the following: |
| 66 | + |
| 67 | +- ``MAJOR``: Incompatible or major changes. |
| 68 | +- ``MINOR``: Backwards-compatible new features and enhancements. |
| 69 | +- ``PATCH``: Backwards-compatible bugfixes and package updates. |
| 70 | + |
| 71 | +## Support |
| 72 | + |
| 73 | +Got questions? |
| 74 | + |
| 75 | +You have several options to get them answered: |
| 76 | + |
| 77 | +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on |
| 78 | + support and feature requests. |
| 79 | +- The [Home Assistant Discord chat server][discord-ha] for general Home |
| 80 | + Assistant discussions and questions. |
| 81 | +- The Home Assistant [Community Forum][forum]. |
| 82 | +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] |
| 83 | + |
| 84 | +You could also [open an issue here][issue] GitHub. |
| 85 | + |
| 86 | +## Authors & contributors |
| 87 | + |
| 88 | +The original setup of this repository is by [Franck Nijhof][frenck]. |
| 89 | + |
| 90 | +For a full list of all authors and contributors, |
| 91 | +check [the contributor's page][contributors]. |
| 92 | + |
| 93 | +## License |
| 94 | + |
| 95 | +MIT License |
| 96 | + |
| 97 | +Copyright (c) 2020 Franck Nijhof |
| 98 | + |
| 99 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 100 | +of this software and associated documentation files (the "Software"), to deal |
| 101 | +in the Software without restriction, including without limitation the rights |
| 102 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 103 | +copies of the Software, and to permit persons to whom the Software is |
| 104 | +furnished to do so, subject to the following conditions: |
| 105 | + |
| 106 | +The above copyright notice and this permission notice shall be included in all |
| 107 | +copies or substantial portions of the Software. |
| 108 | + |
| 109 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 110 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 111 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 112 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 113 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 114 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 115 | +SOFTWARE. |
| 116 | + |
| 117 | +[contributors]: https://github.com/hassio-addons/addon-phpmyadmin/graphs/contributors |
| 118 | +[discord-ha]: https://discord.gg/c5DvZ4e |
| 119 | +[discord]: https://discord.me/hassioaddons |
| 120 | +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-phpmyadmin/171729?u=frenck |
| 121 | +[frenck]: https://github.com/frenck |
| 122 | +[issue]: https://github.com/hassio-addons/addon-phpmyadmin/issues |
| 123 | +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ |
| 124 | +[reddit]: https://reddit.com/r/homeassistant |
| 125 | +[releases]: https://github.com/hassio-addons/addon-phpmyadmin/releases |
| 126 | +[semver]: http://semver.org/spec/v2.0.0.htm |
0 commit comments