diff --git a/source/_docs/ecosystem/apache.markdown b/source/_docs/ecosystem/apache.markdown index 295b64f588c..2c535697c12 100644 --- a/source/_docs/ecosystem/apache.markdown +++ b/source/_docs/ecosystem/apache.markdown @@ -14,7 +14,7 @@ This is useful if you want to have: #### Subdomain -So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123 +So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at `http://localhost:8123` Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html) by running if you encounter issues while serving Home Assistant through your proxy: @@ -22,7 +22,7 @@ Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_ws $ sudo a2enmod proxy_wstunnel ``` -To be able to access to your Home Assistant instance by using https://home.example.org, add the following file to `/etc/httpd/conf/extra/` as `hass.conf` +To be able to access to your Home Assistant instance by using `https://home.example.org`, add the following file to `/etc/httpd/conf/extra/` as `hass.conf` ```text @@ -68,9 +68,9 @@ In case you are getting occasional HTTP 504 error messages ("Gateway Timeout") o #### Multiple Instance -You already have Home Assistant running on http://localhost:8123 and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml` +You already have Home Assistant running on `http://localhost:8123` and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml` -You want another instance available at https://countryside.example.org +You want another instance available at `https://countryside.example.org` You can either : * Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user @@ -84,9 +84,9 @@ http: ... ``` -Start Home Assistant: Now, you have another instance running on http://localhost:8124 +Start Home Assistant: Now, you have another instance running on `http://localhost:8124` -To access this instance by using https://countryside.example.org add to `/etc/httpd/conf/extra/hass.conf` +To access this instance by using `https://countryside.example.org` add to `/etc/httpd/conf/extra/hass.conf` ```text diff --git a/source/_docs/ecosystem/nginx_subdomain.markdown b/source/_docs/ecosystem/nginx_subdomain.markdown index 49bd7ff8ca8..c749b49d5ee 100644 --- a/source/_docs/ecosystem/nginx_subdomain.markdown +++ b/source/_docs/ecosystem/nginx_subdomain.markdown @@ -13,9 +13,9 @@ This is useful if you want to have: #### Subdomain -So you already have a working NGINX server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123 +So you already have a working NGINX server available at example.org. Your Home Assistant is correctly working on this web server and available at `http://localhost:8123` -To be able to access to your Home Assistant instance by using https://home.example.org, create file `/etc/nginx/sites-enabled/homeassistant` (or symlink via `/etc/nginx/sites-available`) and add the following: +To be able to access to your Home Assistant instance by using `https://home.example.org`, create file `/etc/nginx/sites-enabled/homeassistant` (or symlink via `/etc/nginx/sites-available`) and add the following: ```nginx server { @@ -52,9 +52,9 @@ If you don't want HTTPS, you can change `listen 443 ssl` to `listen 80` or bette #### Multiple Instance -You already have Home Assistant running on http://localhost:8123 and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`. +You already have Home Assistant running on `http://localhost:8123` and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`. -You want another instance available at https://countryside.example.org +You want another instance available at `https://countryside.example.org` You can either : * Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user @@ -68,9 +68,9 @@ http: ... ``` -Start Home Assistant: Now, you have another instance running on http://localhost:8124 +Start Home Assistant: Now, you have another instance running on `http://localhost:8124` -To access this instance by using https://countryside.example.org create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following: +To access this instance by using `https://countryside.example.org` create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following: ```nginx server { diff --git a/source/_docs/ecosystem/notebooks/installation.markdown b/source/_docs/ecosystem/notebooks/installation.markdown index 08600ada88d..0afed74486d 100644 --- a/source/_docs/ecosystem/notebooks/installation.markdown +++ b/source/_docs/ecosystem/notebooks/installation.markdown @@ -4,7 +4,7 @@ description: "Setup and first steps for Jupyter Notebooks and Home Assistant." redirect_from: /ecosystem/notebooks/installation/ --- -To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/getting-started/installation-virtualenv/) in order to properly manage dependencies. +To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/docs/installation/virtualenv/) in order to properly manage dependencies. ```bash $ pip3 install jupyter matplotlib @@ -27,7 +27,7 @@ $ jupyter notebook [I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation). ``` -Open [http://localhost:8888/](http://localhost:8888/) in your browser. Press "New" -> "Python3" to open a new notebook. +Open `http://localhost:8888/` in your browser. Press "New" -> "Python3" to open a new notebook.

@@ -43,5 +43,3 @@ The downloadable version of this notebook is available in the [Home Assistant no As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work. - - diff --git a/source/_docs/installation/armbian.markdown b/source/_docs/installation/armbian.markdown index f26dfca7c2b..3c61119fc87 100644 --- a/source/_docs/installation/armbian.markdown +++ b/source/_docs/installation/armbian.markdown @@ -24,7 +24,7 @@ hass --open-ui Running these commands will: - Install Home Assistant - - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) + - Launch Home Assistant and serve the web interface on `http://localhost:8123` - the configuration files will be created in /home/{user}/.homeassistant diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index d5430e0c6bc..027ae1c2fd8 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -36,7 +36,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host, $ docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable ``` -Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. +Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. ### Windows @@ -51,11 +51,11 @@ netsh interface portproxy add v4tov4 listenaddress=192.168.1.10 listenport=8123 netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 connectaddress=10.0.50.2 connectport=8123 ``` -This will let you access your Home Assistant portal from , and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container. +This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container. ### Synology NAS -As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see +As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see The steps would be: * Install "Docker" package on your Synology NAS diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index e2e640fffff..cb39fdbf175 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -22,7 +22,7 @@ The following configuration has been tested on Synology 413j running DSM 6.0-732 Running these commands will: - Install Home Assistant - - Enable Home Assistant to be launched on [http://localhost:8123](http://localhost:8123) + - Enable Home Assistant to be launched on `http://localhost:8123` Using the Synology webadmin: diff --git a/source/_integrations/cover.rfxtrx.markdown b/source/_integrations/cover.rfxtrx.markdown index 43a150ffe53..21da46532d5 100644 --- a/source/_integrations/cover.rfxtrx.markdown +++ b/source/_integrations/cover.rfxtrx.markdown @@ -23,7 +23,7 @@ cover: automatic_add: true ``` -Launch your homeassistant and go the website (e.g http://localhost:8123). Push your remote and your device should be added. +Launch your homeassistant and go the website (e.g `http://localhost:8123`). Push your remote and your device should be added. Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend. Then you should update your configuration to: diff --git a/source/_integrations/lametric.markdown b/source/_integrations/lametric.markdown index 09cbab06ed5..7d0345b5913 100644 --- a/source/_integrations/lametric.markdown +++ b/source/_integrations/lametric.markdown @@ -33,7 +33,7 @@ These are the steps to take: 3. Fill in the form. You can put almost anything in the fields, they just need to be populated: * App Name: Home Assistant * Description: Home Assistant - * Privacy Policy: http://localhost/ + * Privacy Policy: `http://localhost/` * Check all permission boxes * Hit Save 4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources), click on "Home Assistant", copy your client ID and client Secret and paste into the Home Assistant configuration block in the previous section. @@ -134,4 +134,4 @@ If you have more than one La Metric device, you can specify which will receive t icon: 'i51' ``` - If target is not specified, all LaMetric devices will be notified. \ No newline at end of file + If target is not specified, all LaMetric devices will be notified.