Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions source/_docs/configuration/basic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,24 @@ If you prefer YAML, you can add the following information to your `configuration

```yaml
homeassistant:
name: Home
latitude: 32.87336
longitude: 117.22743
elevation: 430
unit_system: metric
time_zone: America/Los_Angeles
name: Home
external_url: "https://www.example.com"
internal_url: "http://homeassistant.local:8123"
whitelist_external_dirs:
- /usr/var/dumping-ground
- /tmp
```

{% configuration %}
name:
description: Name of the location where Home Assistant is running.
required: false
type: string
latitude:
description: Latitude of your location required to calculate the time the sun rises and sets.
required: false
Expand All @@ -46,8 +52,12 @@ time_zone:
description: "Pick your time zone from the column **TZ** of [Wikipedia's list of tz database time zones](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
required: false
type: string
name:
description: Name of the location where Home Assistant is running.
external_url:
description: "The URL that Home Assistant is available on from the internet. For example: `https://example.duckdns.org:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
required: false
type: string
internal_url:
description: "The URL that Home Assistant is available on from your local network. For example: `http://homeassistant.local:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
required: false
type: string
customize:
Expand All @@ -68,6 +78,6 @@ whitelist_external_dirs:
type: list
{% endconfiguration %}

### Reload Core Service
## Reload Core Service

Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "Service" tab under Developer Tools, select the `homeassistant.reload_core_config` service and click the "CALL SERVICE" button. Alternatively, you can press the "Reload Location & Customizations" button under Configuration > Server Control.
3 changes: 0 additions & 3 deletions source/_docs/ecosystem/caddy.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ On your `configuration.yaml` file, edit the `http` component.
http:
# For extra security set this to only accept connections on localhost if Caddy is on the same machine
# server_host: 127.0.0.1
# Update this line to be your domain
base_url: https://example.com
use_x_forwarded_for: true
# You must set the trusted proxy IP address so that Home Assistant will properly accept connections
# Set this to your Caddy machine IP, or localhost if hosted on the same machine.
Expand All @@ -57,4 +55,3 @@ http:

You can either start Caddy or [install it as a service](https://github.com/mholt/caddy/wiki/Caddy-as-a-service-examples), pass the Caddyfile path as a `conf` parameter.
Home Assistant will be listening on port 443 (HTTPS) and all insecure traffic on port 80 will be redirected.

3 changes: 2 additions & 1 deletion source/_docs/ecosystem/certificates/lets_encrypt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,10 @@ Now edit your `configuration.yaml` file to reflect the SSL entries and your base
http:
ssl_certificate: /etc/letsencrypt/live/examplehome.duckdns.org/fullchain.pem
ssl_key: /etc/letsencrypt/live/examplehome.duckdns.org/privkey.pem
base_url: examplehome.duckdns.org
Comment thread
frenck marked this conversation as resolved.
```

Go to the Home Assistant UI -> **Configuration** -> **General** and set the external URL to your new URL, for example: `https://examplehome.duckdns.org`. Please note, advanced mode on your user profile must be enabled in order to see the external URL option.

You may wish to set up other options for the [HTTP](/integrations/http/) integration at this point, these extra options are beyond the scope of this guide.

Save the changes to `configuration.yaml`. Restart Home Assistant.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ The [`http`](/integrations/http/) section must contain the full path to the need

```yaml
http:
base_url: https://mydomain.com:8123
ssl_certificate: /etc/letsencrypt/live/mydomain.com/fullchain.pem
ssl_key: /etc/letsencrypt/live/mydomain.com/privkey.pem
```
Expand Down
6 changes: 4 additions & 2 deletions source/_docs/ecosystem/haproxy.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,16 @@ In your `configuration.yaml` file, edit the [HTTP component](/integrations/http/
http:
# For extra security set this to only accept connection on localhost if HAProxy is on the same machine
# server_host: 127.0.0.1
# Update this line to be your domain
base_url: https://example.com
Comment thread
frenck marked this conversation as resolved.
use_x_forwarded_for: true
# You must set the trusted proxy IP address so that Home Assistant will properly accept connections
# Set this to your HAProxy machine IP, or localhost if hosted on the same machine.
trusted_proxies: <HAProxy IP address here, 127.0.0.1 if same machine>
```

Go to the Home Assistant UI -> **Configuration** -> **General** and set the external URL
to your new URL, for example: `https://examplehome.duckdns.org`.
Please note, advanced mode on your user profile must be enabled in order to see the external URL option.

### Restart or Reload HAProxy

Use your OS method of restarting or reloading HAProxy. Use Google for this.
4 changes: 2 additions & 2 deletions source/_docs/ecosystem/nginx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,14 @@ On your `configuration.yaml` file, edit the `http` component.
http:
# For extra security set this to only accept connections on localhost if NGINX is on the same machine
# server_host: 127.0.0.1
# Update this line to be your domain
Comment thread
frenck marked this conversation as resolved.
base_url: https://example.com
use_x_forwarded_for: true
# You must set the trusted proxy IP address so that Home Assistant will properly accept connections
# Set this to your NGINX machine IP, or localhost if hosted on the same machine.
trusted_proxies: <NGINX IP address here, or 127.0.0.1 if hosted on the same machine>
```

Go to the Home Assistant UI -> **Configuration** -> **General** and set the external URL to your new URL, for example: `https://examplehome.duckdns.org`. Please note, advanced mode on your user profile must be enabled in order to see the external URL option.

### NGINX configuration

```nginx
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/ambiclimate.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_domain: ambiclimate
Integrates [Ambiclimate](https://ambiclimate.com/) Air Conditioning controller into Home Assistant.

You must create an application [here](https://api.ambiclimate.com/clients) to obtain a `client_id` and `client_secret`.
The `callback url` should be configured as your Home Assistant `base_url` + `/api/ambiclimate`, e.g., `https://example.com/api/ambiclimate`.
The `callback url` should be configured as your Home Assistant external URL + `/api/ambiclimate`, e.g., `https://example.com/api/ambiclimate`.

To enable this platform, add the following lines to your `configuration.yaml` file:

Expand Down
3 changes: 2 additions & 1 deletion source/_integrations/cast.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@ Home Assistant has its own Cast application to show the Home Assistant UI on any
```
<div class='note'>

Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `base_url` for [the `http` integration](/integrations/http/).
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).

</div>

## Advanced use

### Manual configuration

By default, any discovered Cast device is added to Home Assistant. This can be restricted by supplying a white list of wanted chrome casts.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/dialogflow.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ha_domain: dialogflow

The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.

To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).

Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.

Expand Down
8 changes: 0 additions & 8 deletions source/_integrations/google_translate.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,3 @@ tts:
- platform: google_translate
language: 'de'
```

If you are using SSL certificate or Docker, you may need to add the `base_url` configuration variable to your `http` integration as follows:

```yaml
#Example configuration.yaml entry
http:
base_url: https://example.duckdns.org
```
5 changes: 0 additions & 5 deletions source/_integrations/http.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@ server_port:
required: false
type: integer
default: 8123
base_url:
description: "The URL that Home Assistant is available on the internet. For example: `https://hass-example.duckdns.org:8123`. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app. Note that this setting may only contain a protocol, hostname and port; using a path is *not* currently supported."
required: false
type: string
default: Your local IP address
ssl_certificate:
description: Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/ifttt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ha_domain: ifttt

## Sending events from IFTTT to Home Assistant

To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic).

### Setting up the integration

Expand Down
6 changes: 0 additions & 6 deletions source/_integrations/image_processing.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ ha_domain: image_processing

Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources.

<div class='note'>

If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [HTTP component](/integrations/http/).

</div>

## ALPR

ALPR entities have a vehicle counter attribute `vehicles` and all found plates are stored in the `plates` attribute.
Expand Down
6 changes: 3 additions & 3 deletions source/_integrations/konnected.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Once all zones are configured you'll be presented with the configuration for add

**Blink panel LED on when sending state change:** The desired LED behavior for the panel.

**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using `base_url` in the `http` component. If you've set `base_url` to an external hostname, then you'll want to check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`).
**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/docs/configuration/basic) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL.

**Override API host URL (optional):** The host info to use if you checked **Override default Home Assistant API host panel URL** in the step above. This is ignored if **Override default Home Assistant API host panel URL** is unchecked.

Expand Down Expand Up @@ -132,10 +132,10 @@ access_token:
required: true
type: string
api_host:
description: Override the IP address/host (and port number) of Home Assistant that the Konnected device(s) will use to communicate sensor state updates. If omitted, this is defaulted to the value of `base_url` in the `http` component. If you've set `base_url` to an external hostname, then you'll want to set this value back to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`).
description: Override the IP address/host (and port number) of Home Assistant that the Konnected device(s) will use to communicate sensor state updates. If omitted, this is defaulted to the value of internal URL from the Home Assistant configuration is used.
required: false
type: string
default: value of `base_url`
default: value of internal URL
devices:
description: A list of Konnected devices that you have on your network.
required: true
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/mailgun.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ha_config_flow: true
ha_domain: mailgun
---

To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the extern URL [configured](/docs/configuration/basic)).

To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/netatmo.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The `netatmo` sensor platform is consuming the information provided by a [Netatm

The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, [Smart Door and Window Sensors](https://www.netatmo.com/en-gb/security/cam-indoor/tag), as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant.

To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the external URL configured in the Home Assistant [configuration](/docs/configuration/basic).

Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations.

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/point.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ha_codeowners:
ha_domain: point
---

The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant `base_url` + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.

Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.

Expand Down
Loading