mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-07-13 01:20:32 +02:00
lint
This commit is contained in:
Alexandre
23
.github/ISSUE_TEMPLATE/bug_report.md
vendored
23
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,21 +1,26 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: '[Addon name] Issue description'
|
||||
title: "[Addon name] Issue description"
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
**Which addon?**
|
||||
|
||||
<!-- The title of the addon this issue is for. -->
|
||||
* Addon name :
|
||||
* Addon version :
|
||||
|
||||
- Addon name :
|
||||
- Addon version :
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
<!-- Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
@@ -23,12 +28,16 @@ assignees: ''
|
||||
4. See error -->
|
||||
|
||||
**Full addon log**
|
||||
|
||||
<!-- The full log that appears when starting the addon -->
|
||||
|
||||
**Full addon config**
|
||||
|
||||
<!-- The addon config in yaml, please remove your passwords-->
|
||||
|
||||
**System**
|
||||
|
||||
<!-- Those information can be found under the Supervisor page on the System tab. -->
|
||||
* Supervisor version: <!--Your Supervisor Version, eg. 209. -->
|
||||
* Host system version: <!--Your Home Assistant (former HASSIO) version, eg. HassOS 3.12 -->
|
||||
|
||||
- Supervisor version: <!--Your Supervisor Version, eg. 209. -->
|
||||
- Host system version: <!--Your Home Assistant (former HASSIO) version, eg. HassOS 3.12 -->
|
||||
|
||||
16
.github/ISSUE_TEMPLATE/feature_request.md
vendored
16
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,25 +1,31 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
**Which addon?**
|
||||
|
||||
<!--The title of the addon the new feature is for.-->
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
|
||||
<!--A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]-->
|
||||
|
||||
**If a new addon, have you checked on Google that such as addon doesn't already exists?
|
||||
\*\*If a new addon, have you checked on Google that such as addon doesn't already exists?
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
<!--A clear and concise description of what you want to happen.-->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
|
||||
<!--A clear and concise description of any alternative solutions or features you've considered.-->
|
||||
|
||||
**Additional context**
|
||||
|
||||
<!--Add any other context or screenshots about the feature request here.-->
|
||||
|
||||
17
.github/ISSUE_TEMPLATE/other_questions.md
vendored
17
.github/ISSUE_TEMPLATE/other_questions.md
vendored
@@ -1,15 +1,17 @@
|
||||
---
|
||||
name: Any other question
|
||||
about: Other questions or remarks not related to bugs or features
|
||||
title: '[addon] title'
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
title: "[addon] title"
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
**Which addon?**
|
||||
|
||||
<!--The title of the addon the new feature is for.-->
|
||||
---
|
||||
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
@@ -19,16 +21,21 @@ assignees: ''
|
||||
---
|
||||
|
||||
**Which addon?**
|
||||
|
||||
<!--The title of the addon the new feature is for.-->
|
||||
|
||||
**Addon or app?**
|
||||
|
||||
<!--Are you sure it is linked to the addon? If in the original app, the question should be posed there.-->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
<!--A clear and concise description of what you want to happen.-->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
|
||||
<!--A clear and concise description of any alternative solutions or features you've considered.-->
|
||||
|
||||
**Additional context**
|
||||
|
||||
<!--Add any other context here.-->
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Home assistant add-on: alexbelgium
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
![update-badge]
|
||||
|
||||
@@ -37,7 +39,7 @@ Adding this add-ons repository to your Home Assistant instance is
|
||||
pretty easy. Follow [the official instructions](https://home-assistant.io/hassio/installing_third_party_addons) on the
|
||||
website of Home Assistant, and use the following URL:
|
||||
|
||||
```
|
||||
```yaml
|
||||
https://github.com/alexbelgium/hassio-addons
|
||||
```
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ For configuration, see https://github.com/troglobit/inadyn
|
||||
|
||||
The available configuration options are as follows (this is filled in with some example data):
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"verify_address": false,
|
||||
"fake_address": false,
|
||||
@@ -70,7 +70,7 @@ The available configuration options are as follows (this is filled in with some
|
||||
|
||||
You should not fill in all of these, only use what is necessary. A typical example would look like:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
{
|
||||
"provider": "duckdns",
|
||||
@@ -83,7 +83,7 @@ You should not fill in all of these, only use what is necessary. A typical examp
|
||||
|
||||
or:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"providers": [
|
||||
{
|
||||
@@ -98,7 +98,7 @@ or:
|
||||
|
||||
for a custom provider that is not supported by inadyn you can do:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"providers": [
|
||||
{
|
||||
|
||||
@@ -45,7 +45,7 @@ APP_BASE_URL: This is the base public URL where the service will be running. For
|
||||
To use an existing PostgresSQL server, set the following variables in the config:
|
||||
Make sure that the provided database and user exist as the server will not create them.
|
||||
|
||||
```
|
||||
```yaml
|
||||
DB_CLIENT=pg
|
||||
POSTGRES_PASSWORD=joplin
|
||||
POSTGRES_DATABASE=joplin
|
||||
@@ -56,7 +56,7 @@ POSTGRES_HOST=localhost
|
||||
|
||||
To use email service, set the follow variables in the config:
|
||||
|
||||
```
|
||||
```yaml
|
||||
1 = true, 0 = false
|
||||
MAILER_HOST=mail.example.com
|
||||
MAILER_PORT=995
|
||||
|
||||
@@ -36,26 +36,15 @@
|
||||
"/dev/nvme1",
|
||||
"/dev/nvme2"
|
||||
],
|
||||
"privileged": [
|
||||
"SYS_ADMIN",
|
||||
"DAC_READ_SEARCH"
|
||||
],
|
||||
"privileged": ["SYS_ADMIN", "DAC_READ_SEARCH"],
|
||||
"ingress": false,
|
||||
"hassio_api": true,
|
||||
"ingress_port": 0,
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armv7"
|
||||
],
|
||||
"arch": ["aarch64", "amd64", "armv7"],
|
||||
"description": "Nextcloud for Home Assistant",
|
||||
"boot": "manual",
|
||||
"uart": true,
|
||||
"map": [
|
||||
"share:rw",
|
||||
"media:rw",
|
||||
"ssl:rw"
|
||||
],
|
||||
"map": ["share:rw", "media:rw", "ssl:rw"],
|
||||
"ports": {
|
||||
"443/tcp": 8099,
|
||||
"80/tcp": null
|
||||
@@ -76,9 +65,7 @@
|
||||
"Full_Text_Search": false,
|
||||
"elasticsearch_server": "<ip:port>"
|
||||
},
|
||||
"services": [
|
||||
"mysql:want"
|
||||
],
|
||||
"services": ["mysql:want"],
|
||||
"schema": {
|
||||
"PUID": "int",
|
||||
"PGID": "int",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
|
||||
$CONFIG = array (
|
||||
'memcache.local' => '\OC\Memcache\APCu',
|
||||
'datadirectory' => '%%datadirectory%%',
|
||||
);
|
||||
|
||||
|
||||
@@ -96,7 +96,7 @@ rest:
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
|
||||
## Environment Variables
|
||||
|
||||
<!-- markdownlint-disable MD007 MD010 MD033 -->
|
||||
|
||||
There are a few optional environment variables available for customizing a Whoogle instance. These can be set manually, or copied into `whoogle.env` and enabled for your preferred deployment method:
|
||||
|
||||
- Local runs: Set `WHOOGLE_DOTENV=1` before running
|
||||
@@ -7,7 +9,7 @@ There are a few optional environment variables available for customizing a Whoog
|
||||
- With `docker build/run`: Add `--env-file ./whoogle.env` to your command
|
||||
|
||||
| Variable | Description |
|
||||
| -------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| ------------------------ | -------------------------------------------------------------------------------------------- |
|
||||
| WHOOGLE_DOTENV | Load environment variables in `whoogle.env` |
|
||||
| WHOOGLE_USER | The username for basic auth. WHOOGLE_PASS must also be set if used. |
|
||||
| WHOOGLE_PASS | The password for basic auth. WHOOGLE_USER must also be set if used. |
|
||||
@@ -21,7 +23,7 @@ There are a few optional environment variables available for customizing a Whoog
|
||||
| WHOOGLE_ALT_YT | The youtube.com alternative to use when site alternatives are enabled in the config. |
|
||||
| WHOOGLE_ALT_IG | The instagram.com alternative to use when site alternatives are enabled in the config. |
|
||||
| WHOOGLE_ALT_RD | The reddit.com alternative to use when site alternatives are enabled in the config. |
|
||||
| WHOOGLE_ALT_TL | The Google Translate alternative to use. This is used for all "translate ____" searches. |
|
||||
| WHOOGLE_ALT_TL | The Google Translate alternative to use. This is used for all "translate \_\_\_\_" searches. |
|
||||
| WHOOGLE_ALT_MD | The medium.com alternative to use when site alternatives are enabled in the config. |
|
||||
| WHOOGLE_AUTOCOMPLETE | Controls visibility of autocomplete/search suggestions. Default on -- use '0' to disable |
|
||||
| WHOOGLE_MINIMAL | Remove everything except basic result cards from all search queries. |
|
||||
@@ -29,10 +31,11 @@ There are a few optional environment variables available for customizing a Whoog
|
||||
| WHOOGLE_RESULTS_PER_PAGE | Set the number of results per page |
|
||||
|
||||
### Config Environment Variables
|
||||
|
||||
These environment variables allow setting default config values, but can be overwritten manually by using the home page config menu. These allow a shortcut for destroying/rebuilding an instance to the same config state every time.
|
||||
|
||||
| Variable | Description |
|
||||
| ------------------------------ | --------------------------------------------------------------- |
|
||||
| ------------------------------ | ------------------------------------------------------------- |
|
||||
| WHOOGLE_CONFIG_DISABLE | Hide config from UI and disallow changes to config by client |
|
||||
| WHOOGLE_CONFIG_COUNTRY | Filter results by hosting country |
|
||||
| WHOOGLE_CONFIG_LANGUAGE | Set interface language |
|
||||
@@ -50,15 +53,19 @@ These environment variables allow setting default config values, but can be over
|
||||
| WHOOGLE_CONFIG_STYLE | The custom CSS to use for styling (should be single line) |
|
||||
|
||||
## Usage
|
||||
|
||||
Same as most search engines, with the exception of filtering by time range.
|
||||
|
||||
To filter by a range of time, append ":past <time>" to the end of your search, where <time> can be `hour`, `day`, `month`, or `year`. Example: `coronavirus updates :past hour`
|
||||
|
||||
## Extra Steps
|
||||
|
||||
### Set Whoogle as your primary search engine
|
||||
*Note: If you're using a reverse proxy to run Whoogle Search, make sure the "Root URL" config option on the home page is set to your URL before going through these steps.*
|
||||
|
||||
_Note: If you're using a reverse proxy to run Whoogle Search, make sure the "Root URL" config option on the home page is set to your URL before going through these steps._
|
||||
|
||||
Browser settings:
|
||||
|
||||
- Firefox (Desktop)
|
||||
- Version 89+
|
||||
- Navigate to your app's url, right click the address bar, and select "Add Search Engine".
|
||||
@@ -87,12 +94,15 @@ Browser settings:
|
||||
- Name: "Whoogle"
|
||||
- Search string to use: `https://\<your whoogle url\>/search?q=%s`
|
||||
- [Alfred](https://www.alfredapp.com/) (Mac OS X)
|
||||
|
||||
1. Go to `Alfred Preferences` > `Features` > `Web Search` and click `Add Custom Search`. Then configure these settings
|
||||
|
||||
- Search URL: `https://\<your whoogle url\>/search?q={query}
|
||||
- Title: `Whoogle for '{query}'` (or whatever you want)
|
||||
- Keyword: `whoogle`
|
||||
|
||||
2. Go to `Default Results` and click the `Setup fallback results` button. Click `+` and add Whoogle, then drag it to the top.
|
||||
|
||||
- Chrome/Chromium-based Browsers
|
||||
- Automatic
|
||||
- Visit the home page of your Whoogle Search instance -- this may automatically add the search engine to your list of search engines. If not, you can add it manually.
|
||||
|
||||
Reference in New Issue
Block a user