mirror of
https://github.com/hassio-addons/repository.git
synced 2025-05-06 12:11:29 +00:00
🎉 Release of add-on SQLite Web 3.0.0
This commit is contained in:
Community Hass.io Add-ons Bot
parent
ba45c667d4
commit
5d39c6b010
5 changed files with 55 additions and 131 deletions
|
|
@ -943,10 +943,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/v2.3.2
|
||||
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/v2.3.2/README.md
|
||||
[addon-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/tree/v3.0.0
|
||||
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/v3.0.0/README.md
|
||||
[sqlite-web-issue]: https://github.com/hassio-addons/addon-sqlite-web/issues
|
||||
[sqlite-web-version-shield]: https://img.shields.io/badge/version-v2.3.2-blue.svg
|
||||
[sqlite-web-version-shield]: https://img.shields.io/badge/version-v3.0.0-blue.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
|
||||
[sqlite-web-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
|
|
|
|||
|
|
@ -1,9 +1,41 @@
|
|||
[Full Changelog][changelog]
|
||||
## What’s changed
|
||||
|
||||
### 🔨 Changes
|
||||
⚠️ This major release of the SQLite Web add-on comes with a lot of breaking changes, so please read this carefully!
|
||||
|
||||
- ⬆ Updates peewee to v3.14.0 (#97)
|
||||
This add-on has been simplified to match the task it was built for: Explore the Home Assistant SQLite database.
|
||||
It now is a single click install and user experience, without the need for any configuration.
|
||||
|
||||
[changelog]: https://github.com/hassio-addons/addon-sqlite-web/compare/v2.3.1...v2.3.2
|
||||
Breaking changes:
|
||||
- Direct access to SQLite Web has been removed.
|
||||
- Datasette has been removed.
|
||||
- All options have been removed.
|
||||
|
||||
Questions? Join our Discord server! https://discord.me/hassioaddons
|
||||
The add-on now opens the Home Assistant database, from its default location and is served via Ingress only.
|
||||
|
||||
## 🚨 Breaking changes
|
||||
|
||||
- Major refactor of add-on @frenck (#114)
|
||||
|
||||
## 🐛 Bug fixes
|
||||
|
||||
- Fix larger table widths on larger screens @frenck (#116)
|
||||
- Fix incorrect ingress template filename @frenck (#117)
|
||||
|
||||
## 🚀 Enhancements
|
||||
|
||||
- Major refactor of add-on @frenck (#114)
|
||||
|
||||
## 🧰 Maintenance
|
||||
|
||||
- Cleanup repository @frenck (#105)
|
||||
- Happy New Year @frenck (#106)
|
||||
- Upgrade Code of Conduct @frenck (#107)
|
||||
- Add new repository workflow @frenck (#108)
|
||||
- Remove obsolete webui from configuration @frenck (#111)
|
||||
|
||||
## ⬆️ Dependency updates
|
||||
|
||||
- ⬆️ Bump actions/stale from v3.0.14 to v3.0.15 @dependabot (#110)
|
||||
- ⬆️ Bump frenck/action-addon-linter from v1.3.1 to v1.4 @dependabot (#109)
|
||||
- Upgrade add-on base image to 9.1.2 @frenck (#113)
|
||||
- ⬆️ Bump frenck/action-yamllint from v1.0.2 to v1.1 @dependabot (#115)
|
||||
|
|
|
|||
|
|
@ -19,92 +19,20 @@ 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/` or the folder path
|
||||
configuration.
|
||||
|
||||
### Option: `folder_path`
|
||||
|
||||
If the database has been moved from `/config/` allows the folder to be specified
|
||||
for example `/share/somefolder/`. Please ensure the trailing slash is set.
|
||||
|
||||
### 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_
|
||||
This add-on has no configuration options.
|
||||
|
||||
## 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].
|
||||
functionality.
|
||||
|
||||
Releases are based on [Semantic Versioning][semver], and use the format
|
||||
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
||||
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.
|
||||
- `MAJOR`: Incompatible or major changes.
|
||||
- `MINOR`: Backwards-compatible new features and enhancements.
|
||||
- `PATCH`: Backwards-compatible bugfixes and package updates.
|
||||
|
||||
## Support
|
||||
|
||||
|
|
@ -132,7 +60,7 @@ check [the contributor's page][contributors].
|
|||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2018-2020 Joakim Sørensen
|
||||
Copyright (c) 2018-2021 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
|
||||
|
|
@ -153,12 +81,10 @@ 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
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ This enables you to easily explore all tables and content that is saved in your
|
|||
[discord]: https://discord.gg/c5DvZ4e
|
||||
[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
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-v2.3.2-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-sqlite-web/tree/v2.3.2
|
||||
[screenshot]: https://github.com/hassio-addons/addon-sqlite-web/raw/master/images/sample-view.png
|
||||
[release-shield]: https://img.shields.io/badge/version-v3.0.0-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-sqlite-web/tree/v3.0.0
|
||||
[screenshot]: https://github.com/hassio-addons/addon-sqlite-web/raw/main/images/sample-view.png
|
||||
|
|
@ -1,14 +1,12 @@
|
|||
{
|
||||
"name": "SQLite Web",
|
||||
"version": "2.3.2",
|
||||
"version": "3.0.0",
|
||||
"slug": "sqlite-web",
|
||||
"description": "Explore your SQLite database",
|
||||
"url": "https://github.com/hassio-addons/addon-sqlite-web/tree/master/README.md",
|
||||
"webui": "[PROTO:ssl]://[HOST]:[PORT:6210]",
|
||||
"url": "https://github.com/hassio-addons/addon-sqlite-web/tree/main/README.md",
|
||||
"ingress": true,
|
||||
"ingress_port": 1337,
|
||||
"advanced": true,
|
||||
"panel_icon": "mdi:database",
|
||||
"startup": "services",
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
|
|
@ -16,40 +14,8 @@
|
|||
"armv7",
|
||||
"i386"
|
||||
],
|
||||
"boot": "auto",
|
||||
"auth_api": true,
|
||||
"hassio_api": true,
|
||||
"hassio_role": "default",
|
||||
"ports": {
|
||||
"80/tcp": null,
|
||||
"6220/tcp": 6220
|
||||
},
|
||||
"ports_description": {
|
||||
"80/tcp": "SQLite Web interface (Not required for Ingress)",
|
||||
"6220/tcp": "Datasette API endpoint"
|
||||
},
|
||||
"map": [
|
||||
"share:rw",
|
||||
"ssl",
|
||||
"config:rw"
|
||||
],
|
||||
"options": {
|
||||
"database_path": "home-assistant_v2.db",
|
||||
"read_only": true,
|
||||
"datasette": false,
|
||||
"ssl": true,
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem"
|
||||
},
|
||||
"schema": {
|
||||
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
|
||||
"database_path": "str",
|
||||
"folder_path": "str?",
|
||||
"read_only": "bool",
|
||||
"datasette": "bool",
|
||||
"ssl": "bool",
|
||||
"certfile": "str",
|
||||
"keyfile": "str"
|
||||
},
|
||||
"image": "hassioaddons/sqlite-web-{arch}"
|
||||
"image": "ghcr.io/hassio-addons/sqlite-web/{arch}"
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue