mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Rename whitelist_external_dirs (#13992)
This commit is contained in:
Paulus Schoutsen
GitHub
parent
32655a5191
commit
fc8d22718e
@ -4,7 +4,7 @@ description: "Setting up the basic info of Home Assistant."
|
||||
redirect_from: /getting-started/basic/
|
||||
---
|
||||
|
||||
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You may adjust this during onboarding, or afterwards at Configuration -> General.
|
||||
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You may adjust this during onboarding, or afterwards at Configuration -> General.
|
||||
|
||||
If you prefer YAML, you can add the following information to your `configuration.yaml`:
|
||||
|
||||
@ -18,7 +18,7 @@ homeassistant:
|
||||
time_zone: America/Los_Angeles
|
||||
external_url: "https://www.example.com"
|
||||
internal_url: "http://homeassistant.local:8123"
|
||||
whitelist_external_dirs:
|
||||
allowlist_external_dirs:
|
||||
- /usr/var/dumping-ground
|
||||
- /tmp
|
||||
allowlist_external_urls:
|
||||
@ -76,7 +76,7 @@ customize_glob:
|
||||
description: "[Customize](/docs/configuration/customizing-devices/) entities matching a pattern."
|
||||
required: false
|
||||
type: string
|
||||
whitelist_external_dirs:
|
||||
allowlist_external_dirs:
|
||||
description: List of folders that can be used as sources for sending files.
|
||||
required: false
|
||||
type: list
|
||||
|
||||
@ -95,7 +95,7 @@ Trigger a camera to take a new still image.
|
||||
|
||||
### `blink.save_video`
|
||||
|
||||
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below).
|
||||
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your `configuration.yaml` file (see example below).
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------- |
|
||||
@ -105,7 +105,7 @@ Save the last recorded video of a camera to a local file. Note that in most case
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
whitelist_external_dirs:
|
||||
allowlist_external_dirs:
|
||||
- '/tmp'
|
||||
- '/path/to/whitelist'
|
||||
```
|
||||
@ -137,7 +137,7 @@ sequence:
|
||||
- service: blink.trigger_camera
|
||||
data:
|
||||
entity_id: camera.blink_my_camera
|
||||
- delay: 00:00:05
|
||||
- delay: 00:00:05
|
||||
- service: blink.blink_update
|
||||
- service: camera.snapshot
|
||||
data:
|
||||
@ -160,7 +160,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that
|
||||
to: 'not_home'
|
||||
action:
|
||||
service: alarm_control_panel.alarm_arm_away
|
||||
entity_id: alarm_control_panel.blink_my_sync_module
|
||||
entity_id: alarm_control_panel.blink_my_sync_module
|
||||
```
|
||||
|
||||
### Disarm Blink When Home
|
||||
@ -176,7 +176,7 @@ Similar to the previous example, this automation will disarm blink when arriving
|
||||
to: 'home'
|
||||
action:
|
||||
service: alarm_control_panel.alarm_disarm
|
||||
entity_id: alarm_control_panel.blink_my_sync_module
|
||||
entity_id: alarm_control_panel.blink_my_sync_module
|
||||
```
|
||||
|
||||
### Save Video Locally When Motion Detected
|
||||
@ -198,6 +198,6 @@ Again, this example assumes your camera's name (in the blink app) is `My Camera`
|
||||
data_template:
|
||||
name: "My Camera"
|
||||
filename: "/tmp/videos/blink_video_{{ now().strftime('%Y%m%d_%H%M%S') }}.mp4"
|
||||
|
||||
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@ -77,7 +77,7 @@ Both `duration` and `lookback` options are suggestions, but should be consistent
|
||||
| `duration` | yes | Target recording length (in seconds). Default: 30 |
|
||||
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
@ -100,7 +100,7 @@ Take a snapshot from a camera.
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ To use notifications, please see the [getting started with automation page](/get
|
||||
|
||||
## Sensor
|
||||
|
||||
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/).
|
||||
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [allowlist_external_dirs](/docs/configuration/basic/).
|
||||
|
||||
To enable the `file` sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ The `filesize` sensor is for displaying the size in MB of a file.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
File paths must also be added to [whitelist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`.
|
||||
File paths must also be added to [allowlist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ ha_release: 0.64
|
||||
ha_domain: folder
|
||||
---
|
||||
|
||||
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
|
||||
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [allowlist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
|
||||
The sensor exposes the number of filtered files in the folder, total size in bytes of those files and a comma separated list of the file paths as attributes.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -16,7 +16,7 @@ This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system
|
||||
* `modified`
|
||||
* `moved`
|
||||
|
||||
Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
Configured folders must be added to [allowlist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
redirect_uri:
|
||||
description: >
|
||||
description: >
|
||||
The redirect URI that corresponds to your Home Assistant instance.
|
||||
It must match one of the redirect URIs specified when you requested API
|
||||
access from Logitech.
|
||||
@ -136,7 +136,7 @@ Initiates a recording of the camera's live stream.
|
||||
| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/recording_{{ entity_id }}.mp4`{% endraw %}. |
|
||||
| `duration` | no | Duration of recording, in seconds.
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
### Service `logi_circle.livestream_snapshot`
|
||||
|
||||
@ -149,7 +149,7 @@ Please note that new snapshots will only be generated if the cached snapshot is
|
||||
| `entity_id` | yes | Name(s) of entities to create a live stream snapshot from, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.jpg`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
### Service `logi_circle.set_config`
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: minio
|
||||
This integration adds interaction with [Minio](https://min.io).
|
||||
It also enables listening for bucket notifications: [see documentation](https://docs.min.io/docs/minio-client-complete-guide.html#watch)
|
||||
|
||||
To download or upload files, folders must be added to [whitelist_external_dirs](/docs/configuration/basic/).
|
||||
To download or upload files, folders must be added to [allowlist_external_dirs](/docs/configuration/basic/).
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -106,7 +106,7 @@ automation:
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: minio
|
||||
|
||||
|
||||
condition: []
|
||||
action:
|
||||
- service: minio.get
|
||||
|
||||
@ -132,4 +132,4 @@ Example for posting file from local path:
|
||||
}
|
||||
```
|
||||
|
||||
Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`.
|
||||
Please note that `path` is validated against the `allowlist_external_dirs` in the `configuration.yaml`.
|
||||
|
||||
@ -45,7 +45,7 @@ notify:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
name:
|
||||
description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
type: string
|
||||
@ -86,7 +86,7 @@ To include a local file with the Slack message, use these attributes underneath
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `path` | no | A local filepath that has been [whitelisted](/docs/configuration/basic/#whitelist_external_dirs).
|
||||
| `path` | no | A local filepath that has been [whitelisted](/docs/configuration/basic/#allowlist_external_dirs).
|
||||
|
||||
To include a remote file with the Slack message, use these attributes underneath the `file` key:
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ Both `duration` and `lookback` options are suggestions, but should be consistent
|
||||
| `duration` | yes | Target recording length (in seconds). Default: 30 |
|
||||
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream for `stream_source`. Default: 0 |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a recording from `rtsp://my.stream.feed:554` and save it to `/config/www`.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ The requirements are:
|
||||
|
||||
- You need a [Telegram bot](https://core.telegram.org/bots). Please follow those [instructions](https://core.telegram.org/bots#6-botfather) to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user.
|
||||
- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_bot) and define there your API key and the allowed chat ids to interact with.
|
||||
- The `chat_id` of an allowed user.
|
||||
- The `chat_id` of an allowed user.
|
||||
|
||||
**Method 1:** You can get your `chat_id` by sending any message to the [GetIDs bot](https://t.me/getidsbot).
|
||||
|
||||
@ -207,7 +207,7 @@ Since Home Assistant version 0.48 you have to [whitelist the source folder](/doc
|
||||
configuration.yaml
|
||||
...
|
||||
homeassistant:
|
||||
whitelist_external_dirs:
|
||||
allowlist_external_dirs:
|
||||
- /tmp
|
||||
- /home/kenji/data
|
||||
```
|
||||
|
||||
@ -68,7 +68,7 @@ scan_interval:
|
||||
required: false
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## Integration Entities
|
||||
|
||||
The Transmission Integration will add the following sensors and switches.
|
||||
@ -120,7 +120,7 @@ Example of configuration of an automation with completed torrents:
|
||||
|
||||
### Service `add_torrent`
|
||||
|
||||
Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#whitelist_external_dirs)).
|
||||
Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#allowlist_external_dirs)).
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
@ -150,7 +150,7 @@ content: >
|
||||
{% set payload = state_attr('sensor.transmission_total_torrents', 'torrent_info') %}
|
||||
|
||||
{% for torrent in payload.items() %} {% set name = torrent[0] %} {% set data = torrent[1] %}
|
||||
|
||||
|
||||
{{ name|truncate(20) }} is {{ data.percent_done }}% complete, {{ data.eta }} remaining {% endfor %}
|
||||
type: markdown
|
||||
```
|
||||
|
||||
@ -146,7 +146,7 @@ Take a snapshot from a camera.
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action is an automation that would take a snapshot from "front_door_camera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
|
||||
@ -125,4 +125,4 @@ tap_action:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `whitelist_external_dirs` ([documentation](/docs/configuration/basic/)).
|
||||
The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `allowlist_external_dirs` ([documentation](/docs/configuration/basic/)).
|
||||
|
||||
@ -79,7 +79,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
whitelist_external_dirs:
|
||||
allowlist_external_dirs:
|
||||
- /tmp
|
||||
- /home/kenji/data
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user