avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-07-10 16:01:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

lint

Browse Source
This commit is contained in:
Alexandre
2022-02-18 17:11:55 +01:00
parent 1d754c6c72
commit 7095c32215
13 changed files with 146 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@@ -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
View File

@@ -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
View File

@@ -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.-->

4
README.md
View File

@@ -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
```

8
inadyn/README.md
View File

@@ -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": [
{

4
joplin/README.md
View File

@@ -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

21
nextcloud/config.json
View File

@@ -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",

2
nextcloud/rootfs/defaults/config.php
View File

@@ -1,6 +1,6 @@
<?php
$CONFIG = array (
'memcache.local' => '\OC\Memcache\APCu',
'datadirectory' => '%%datadirectory%%',
);

2
scrutiny/README.md
View File

@@ -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

166
whoogle/DOCS.md
View File

@@ -1,100 +1,110 @@
## 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
- 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://<your url>/`) |
| 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://<your url>/`) |
| 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".
- Previous versions
- Navigate to your app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine".
- Once you've added the new search engine, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Whoogle" from the list.
- **Note**: If your Whoogle instance uses Firefox Containers, you'll need to [go through the steps here](#using-with-firefox-containers) to get it working properly.
- Firefox (iOS)
- In the mobile app Settings page, tap "Search" within the "General" section. There should be an option titled "Add Search Engine" to select. It should prompt you to enter a title and search query url - use the following elements to fill out the form:
- Title: "Whoogle"
- URL: `http[s]://\<your whoogle url\>/search?q=%s`
- Firefox (Android)
- Version <79.0.0
- Navigate to your app's url
- Long-press on the search text field
- Click the "Add Search Engine" menu item
- Select a name and click ok
- Click the 3 dot menu in the top right
- Navigate to the settings menu and select the "Search" sub-menu
- Select Whoogle and press "Set as default"
- Version >=79.0.0
- Click the 3 dot menu in the top right
- Navigate to the settings menu and select the "Search" sub-menu
- Click "Add search engine"
- Select the 'Other' radio button
- 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.
- Manual
- Under search engines > manage search engines > add, manually enter your Whoogle instance details with a `<whoogle url>/search?q=%s` formatted search URL.
- Firefox (Desktop)
- Version 89+
- Navigate to your app's url, right click the address bar, and select "Add Search Engine".
- Previous versions
- Navigate to your app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine".
- Once you've added the new search engine, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Whoogle" from the list.
- **Note**: If your Whoogle instance uses Firefox Containers, you'll need to [go through the steps here](#using-with-firefox-containers) to get it working properly.
- Firefox (iOS)
- In the mobile app Settings page, tap "Search" within the "General" section. There should be an option titled "Add Search Engine" to select. It should prompt you to enter a title and search query url - use the following elements to fill out the form:
- Title: "Whoogle"
- URL: `http[s]://\<your whoogle url\>/search?q=%s`
- Firefox (Android)
- Version <79.0.0
- Navigate to your app's url
- Long-press on the search text field
- Click the "Add Search Engine" menu item
- Select a name and click ok
- Click the 3 dot menu in the top right
- Navigate to the settings menu and select the "Search" sub-menu
- Select Whoogle and press "Set as default"
- Version >=79.0.0
- Click the 3 dot menu in the top right
- Navigate to the settings menu and select the "Search" sub-menu
- Click "Add search engine"
- Select the 'Other' radio button
- 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.
- Manual
- Under search engines > manage search engines > add, manually enter your Whoogle instance details with a `<whoogle url>/search?q=%s` formatted search URL.