mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-05 19:51:22 +00:00
⬆️ Updating add-on SQLite Web to 14fd882
This commit is contained in:
parent
51e9098241
commit
f5d9b17bf7
5 changed files with 167 additions and 9 deletions
|
@ -1116,10 +1116,10 @@ SOFTWARE.
|
|||
[portainer-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[portainer-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
[portainer-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
||||
[addon-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/tree/0fa1a39
|
||||
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/0fa1a39/README.md
|
||||
[addon-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/tree/14fd882
|
||||
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/14fd882/README.md
|
||||
[sqlite-web-issue]: https://github.com/hassio-addons/addon-sqlite-web/issues
|
||||
[sqlite-web-version-shield]: https://img.shields.io/badge/version-0fa1a39-blue.svg
|
||||
[sqlite-web-version-shield]: https://img.shields.io/badge/version-14fd882-blue.svg
|
||||
[sqlite-web-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/sqlite-web-armhf.svg
|
||||
[sqlite-web-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||
[sqlite-web-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
|
|
|
@ -1,4 +1,6 @@
|
|||
# Changelog since v2.2.1
|
||||
- ✏ Split add-on documentation
|
||||
- ⬆ Upgrades add-on base image to v5.2.1
|
||||
- ⬆ Updates datasette to v0.43 (#78)
|
||||
|
||||
Co-authored-by: Renovate Bot <bot@renovateapp.com>
|
||||
|
|
159
sqlite-web/DOCS.md
Normal file
159
sqlite-web/DOCS.md
Normal file
|
@ -0,0 +1,159 @@
|
|||
# Home Assistant Community Add-on: SQLite Web
|
||||
|
||||
This enables you to easily explore all tables and content that is saved in your database.
|
||||
|
||||
## 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 “SQLite Web” add-on in the Hass.io 166 add-on store
|
||||
and install it.
|
||||
1. Start the "SQLite Web" add-on
|
||||
1. Check the logs of the "SQLite Web" add-on to see if everything went well.
|
||||
1. Click "OPEN WEB UI" to open the SQLite Web interface.
|
||||
1. Log in with your Home Assistant user.
|
||||
|
||||
**NOTE**: Starting the add-on might take a couple of minutes (especially the
|
||||
first time starting the add-on).
|
||||
|
||||
## Configuration
|
||||
|
||||
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||
|
||||
Example add-on configuration:
|
||||
|
||||
```yaml
|
||||
log_level: info
|
||||
database_path: home-assistant_v2.db
|
||||
read_only: true
|
||||
datasette: false
|
||||
ssl: true
|
||||
certfile: fullchain.pem
|
||||
keyfile: privkey.pem
|
||||
```
|
||||
|
||||
**Note**: _This is just an example, don't copy and past 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.
|
||||
|
||||
### Option: `database_path`
|
||||
|
||||
The path for the database file relative to `/config/`
|
||||
|
||||
### Option: `read_only`
|
||||
|
||||
Open the database in read only mode if `true`.
|
||||
**It is not recommended setting this to `false`,
|
||||
this will enable you to corrupt the database!**
|
||||
|
||||
### Option: `datasette`
|
||||
|
||||
This option enables the optional service [Datasette]
|
||||
that can serve as an API to your DB.
|
||||
This endpoint will be exposed to port `6220`
|
||||
|
||||
### Option: `ssl`
|
||||
|
||||
Enables/Disables SSL (HTTPS) on the web interface of SQLite Web. Set it `true`
|
||||
to enable it, `false` otherwise.
|
||||
|
||||
### Option: `certfile`
|
||||
|
||||
The certificate file to use for SSL.
|
||||
|
||||
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
||||
|
||||
### Option: `keyfile`
|
||||
|
||||
The private key file to use for SSL.
|
||||
|
||||
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
|
||||
|
||||
## 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 [Joakim Sørensen][ludeeus].
|
||||
|
||||
For a full list of all authors and contributors,
|
||||
check [the contributor's page][contributors].
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2018-2020 Joakim Sørensen
|
||||
|
||||
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-sqlite-web/graphs/contributors
|
||||
[Datasette]: https://github.com/simonw/datasette
|
||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-sqlite-web/68912?u=frenck
|
||||
[issue]: https://github.com/hassio-addons/addon-sqlite-web/issues
|
||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||
[ludeeus]: https://github.com/ludeeus
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[releases]: https://github.com/hassio-addons/addon-sqlite-web/releases
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
|
@ -12,8 +12,6 @@ Explore your Home-Assistant database from your web browser!
|
|||
|
||||
This enables you to easily explore all tables and content that is saved in your database.
|
||||
|
||||
[Click here for the full documentation][docs]
|
||||
|
||||
![SQLite Web screenshot][screenshot]
|
||||
|
||||
## WARNING! THIS IS AN EDGE VERSION!
|
||||
|
@ -39,11 +37,10 @@ If you are more interested in stable releases of our add-ons:
|
|||
[buymeacoffee]: https://www.buymeacoffee.com/ludeeus
|
||||
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg
|
||||
[discord]: https://discord.gg/c5DvZ4e
|
||||
[docs]: https://github.com/hassio-addons/addon-sqlite-web/blob/0fa1a39/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-sqlite-web/68912?u=frenck
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-0fa1a39-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-sqlite-web/tree/0fa1a39
|
||||
[release-shield]: https://img.shields.io/badge/version-14fd882-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-sqlite-web/tree/14fd882
|
||||
[screenshot]: https://github.com/hassio-addons/addon-sqlite-web/raw/master/images/sample-view.png
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "SQLite Web",
|
||||
"version": "0fa1a39",
|
||||
"version": "14fd882",
|
||||
"slug": "sqlite-web",
|
||||
"description": "Explore your SQLite database",
|
||||
"url": "https://github.com/hassio-addons/addon-sqlite-web/tree/master/README.md",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue