From 7095c32215101f55154c5caa0d65bc5aaf1f0761 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Fri, 18 Feb 2022 17:11:55 +0100 Subject: [PATCH] lint --- .github/ISSUE_TEMPLATE/bug_report.md | 23 ++- .github/ISSUE_TEMPLATE/feature_request.md | 16 ++- .github/ISSUE_TEMPLATE/other_questions.md | 17 ++- README.md | 4 +- booksonic_air/Readme.md | 2 +- inadyn/README.md | 8 +- joplin/README.md | 4 +- nextcloud/config.json | 21 +-- nextcloud/rootfs/defaults/config.php | 2 +- qbittorrent/CHANGELOG.md | 2 +- scrutiny/README.md | 2 +- spotweb/DOCS.md | 4 +- whoogle/DOCS.md | 166 ++++++++++++---------- 13 files changed, 146 insertions(+), 125 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0b1b80095..2ef04410b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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: "" --- + + **Which addon?** + -* Addon name : -* Addon version : + +- Addon name : +- Addon version : **Describe the bug** + **To Reproduce** + **Full addon log** + **Full addon config** + **System** + -* Supervisor version: -* Host system version: + +- Supervisor version: +- Host system version: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index da4ac82ef..c1564e242 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,25 +1,31 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- + + **Which addon?** + **Is your feature request related to a problem? Please describe.** + -**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** + **Describe alternatives you've considered** + **Additional context** + diff --git a/.github/ISSUE_TEMPLATE/other_questions.md b/.github/ISSUE_TEMPLATE/other_questions.md index 11a1a0c9b..519d98f44 100644 --- a/.github/ISSUE_TEMPLATE/other_questions.md +++ b/.github/ISSUE_TEMPLATE/other_questions.md @@ -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: "" --- + + **Which addon?** + ---- + name: Feature request about: Suggest an idea for this project title: '' @@ -19,16 +21,21 @@ assignees: '' --- **Which addon?** + **Addon or app?** + **Describe the solution you'd like** + **Describe alternatives you've considered** + **Additional context** + diff --git a/README.md b/README.md index ae9c9863a..98398b6bf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Home assistant add-on: alexbelgium + + [![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 ``` diff --git a/booksonic_air/Readme.md b/booksonic_air/Readme.md index ddf3f3016..62a5dc57a 100644 --- a/booksonic_air/Readme.md +++ b/booksonic_air/Readme.md @@ -1,5 +1,5 @@ # Home assistant add-on: booksonic-air - + [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white diff --git a/inadyn/README.md b/inadyn/README.md index dd1c6d0ce..c61305d85 100644 --- a/inadyn/README.md +++ b/inadyn/README.md @@ -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": [ { diff --git a/joplin/README.md b/joplin/README.md index 0618c7325..b4a54498b 100644 --- a/joplin/README.md +++ b/joplin/README.md @@ -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 diff --git a/nextcloud/config.json b/nextcloud/config.json index 08e4ca526..0f56138b9 100644 --- a/nextcloud/config.json +++ b/nextcloud/config.json @@ -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": "" }, - "services": [ - "mysql:want" - ], + "services": ["mysql:want"], "schema": { "PUID": "int", "PGID": "int", diff --git a/nextcloud/rootfs/defaults/config.php b/nextcloud/rootfs/defaults/config.php index 9a534907c..7dcfb750e 100644 --- a/nextcloud/rootfs/defaults/config.php +++ b/nextcloud/rootfs/defaults/config.php @@ -1,6 +1,6 @@ '\OC\Memcache\APCu', 'datadirectory' => '%%datadirectory%%', ); - diff --git a/qbittorrent/CHANGELOG.md b/qbittorrent/CHANGELOG.md index a4f2bb424..2ce87c8af 100644 --- a/qbittorrent/CHANGELOG.md +++ b/qbittorrent/CHANGELOG.md @@ -1,4 +1,4 @@ -- Host header validation disabled (avoids ingress issues) +- Host header validation disabled (avoids ingress issues) - Removed openvpn_alternative_mode (please delete from config), now default - Changed openvpn mode to interface binding (no ip leakage) diff --git a/scrutiny/README.md b/scrutiny/README.md index af03e42f5..031835719 100644 --- a/scrutiny/README.md +++ b/scrutiny/README.md @@ -96,7 +96,7 @@ rest: --- -![](https://github.com/AnalogJ/scrutiny/raw/master/docs/dashboard.png) +![Illustration](https://github.com/AnalogJ/scrutiny/raw/master/docs/dashboard.png) ## Support diff --git a/spotweb/DOCS.md b/spotweb/DOCS.md index e557dffba..b7ec043ac 100644 --- a/spotweb/DOCS.md +++ b/spotweb/DOCS.md @@ -23,12 +23,12 @@ All you have to do: enter your usenet server details and your download client (e The official documentation mentions: Please run 'http://yourdomain.com/install.php' from within your browser before attempting anything further with Spotweb and make sure all items are checked 'OK'. -These steps can be skipped as this addon will automatically configure and create the database. +These steps can be skipped as this addon will automatically configure and create the database. All you have to do: enter your usenet server details and your download client (eg: nzbget). **Note**: Spots are retrieved via an hourly cron job. It can take up to an hour before the spots start appearing. -Depending on the specs of your system, it can take more than 24 hours before all spots are retrieved. +Depending on the specs of your system, it can take more than 24 hours before all spots are retrieved. ## Configuration Addon diff --git a/whoogle/DOCS.md b/whoogle/DOCS.md index 534a13b43..2e4b83396 100644 --- a/whoogle/DOCS.md +++ b/whoogle/DOCS.md @@ -1,100 +1,110 @@ - ## Environment Variables + + + 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 - With `docker-compose`: Uncomment the `env_file` option - 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. | -| WHOOGLE_PROXY_USER | The username of the proxy server. | -| WHOOGLE_PROXY_PASS | The password of the proxy server. | -| WHOOGLE_PROXY_TYPE | The type of the proxy server. Can be "socks5", "socks4", or "http". | -| WHOOGLE_PROXY_LOC | The location of the proxy server (host or ip). | -| EXPOSE_PORT | The port where Whoogle will be exposed. | -| HTTPS_ONLY | Enforce HTTPS. (See [here](https://github.com/benbusby/whoogle-search#https-enforcement)) | -| WHOOGLE_ALT_TW | The twitter.com alternative to use when site alternatives are enabled in the config. | -| 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_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. | -| WHOOGLE_CSP | Sets a default set of 'Content-Security-Policy' headers | -| WHOOGLE_RESULTS_PER_PAGE | Set the number of results per page | +| 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. | +| WHOOGLE_PROXY_USER | The username of the proxy server. | +| WHOOGLE_PROXY_PASS | The password of the proxy server. | +| WHOOGLE_PROXY_TYPE | The type of the proxy server. Can be "socks5", "socks4", or "http". | +| WHOOGLE_PROXY_LOC | The location of the proxy server (host or ip). | +| EXPOSE_PORT | The port where Whoogle will be exposed. | +| HTTPS_ONLY | Enforce HTTPS. (See [here](https://github.com/benbusby/whoogle-search#https-enforcement)) | +| WHOOGLE_ALT_TW | The twitter.com alternative to use when site alternatives are enabled in the config. | +| 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_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. | +| WHOOGLE_CSP | Sets a default set of 'Content-Security-Policy' headers | +| 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 | -| WHOOGLE_CONFIG_SEARCH_LANGUAGE | Set search result language | -| WHOOGLE_CONFIG_BLOCK | Block websites from search results (use comma-separated list) | -| WHOOGLE_CONFIG_THEME | Set theme mode (light, dark, or system) | -| WHOOGLE_CONFIG_SAFE | Enable safe searches | -| WHOOGLE_CONFIG_ALTS | Use social media site alternatives (nitter, invidious, etc) | -| WHOOGLE_CONFIG_NEAR | Restrict results to only those near a particular city | -| WHOOGLE_CONFIG_TOR | Use Tor routing (if available) | -| WHOOGLE_CONFIG_NEW_TAB | Always open results in new tab | -| WHOOGLE_CONFIG_VIEW_IMAGE | Enable View Image option | -| WHOOGLE_CONFIG_GET_ONLY | Search using GET requests only | -| WHOOGLE_CONFIG_URL | The root url of the instance (`https:///`) | -| WHOOGLE_CONFIG_STYLE | The custom CSS to use for styling (should be single line) | +| 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 | +| WHOOGLE_CONFIG_SEARCH_LANGUAGE | Set search result language | +| WHOOGLE_CONFIG_BLOCK | Block websites from search results (use comma-separated list) | +| WHOOGLE_CONFIG_THEME | Set theme mode (light, dark, or system) | +| WHOOGLE_CONFIG_SAFE | Enable safe searches | +| WHOOGLE_CONFIG_ALTS | Use social media site alternatives (nitter, invidious, etc) | +| WHOOGLE_CONFIG_NEAR | Restrict results to only those near a particular city | +| WHOOGLE_CONFIG_TOR | Use Tor routing (if available) | +| WHOOGLE_CONFIG_NEW_TAB | Always open results in new tab | +| WHOOGLE_CONFIG_VIEW_IMAGE | Enable View Image option | +| WHOOGLE_CONFIG_GET_ONLY | Search using GET requests only | +| WHOOGLE_CONFIG_URL | The root url of the instance (`https:///`) | +| 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