mirror of
https://github.com/weewx/weewx.git
synced 2026-04-22 02:27:03 -04:00
provide guidance about installing extensions
This commit is contained in:
@@ -79,14 +79,19 @@ To enable uploads or to customize reports, modify the configuration file.
|
||||
See the [*Customization Guide*](../custom/introduction.md) for instructions,
|
||||
and the [application](../reference/weewx-options/introduction.md) and
|
||||
[skin](../reference/skin-options/introduction.md) references for all
|
||||
the options.
|
||||
|
||||
Use any text editor, such as `nano`:
|
||||
the options. Use any text editor, such as `nano`:
|
||||
|
||||
```shell
|
||||
sudo nano /etc/weewx/weewx.conf
|
||||
```
|
||||
|
||||
To install new skins, drivers, or other extensions, use the `weectl` utility
|
||||
and the URL to the extension.
|
||||
|
||||
```shell
|
||||
sudo weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
WeeWX must be restarted for the changes to take effect.
|
||||
```{.shell .copy}
|
||||
sudo systemctl restart weewx
|
||||
|
||||
@@ -132,9 +132,18 @@ To enable uploads or to customize reports, modify the configuration file.
|
||||
See the [*Customization Guide*](../custom/introduction.md) for instructions,
|
||||
and the [application](../reference/weewx-options/introduction.md) and
|
||||
[skin](../reference/skin-options/introduction.md) references for all the
|
||||
options.
|
||||
options. Use any text editor, such as `nano`:
|
||||
|
||||
nano ~/weewx-data/weewx.conf
|
||||
```{.shell .copy}
|
||||
nano ~/weewx-data/weewx.conf
|
||||
```
|
||||
|
||||
To install new skins, drivers, or other extensions, use the `weectl` utility
|
||||
and the URL to the extension.
|
||||
|
||||
```{.shell .copy}
|
||||
weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
The executable `weewxd` must be restarted for the changes to take effect.
|
||||
|
||||
|
||||
@@ -300,14 +300,19 @@ To enable uploads or to customize reports, modify the configuration file.
|
||||
See the [*Customization Guide*](../custom/introduction.md) for instructions,
|
||||
and the [application](../reference/weewx-options/introduction.md) and
|
||||
[skin](../reference/skin-options/introduction.md) references for all
|
||||
the options.
|
||||
|
||||
Use any text editor, such as `nano`:
|
||||
the options. Use any text editor, such as `nano`:
|
||||
|
||||
```shell
|
||||
nano ~/weewx-data/weewx.conf
|
||||
```
|
||||
|
||||
To install new skins, drivers, or other extensions, use the `weectl` utility
|
||||
and the URL to the extension.
|
||||
|
||||
```shell
|
||||
weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
WeeWX must be restarted for the changes to take effect.
|
||||
|
||||
=== "systemd"
|
||||
|
||||
@@ -82,14 +82,19 @@ To enable uploads or to customize reports, modify the configuration file.
|
||||
See the [*Customization Guide*](../custom/introduction.md) for instructions,
|
||||
and the [application](../reference/weewx-options/introduction.md) and
|
||||
[skin](../reference/skin-options/introduction.md) references for all
|
||||
the options.
|
||||
|
||||
Use any text editor, such as `nano`:
|
||||
the options. Use any text editor, such as `nano`:
|
||||
|
||||
```shell
|
||||
sudo nano /etc/weewx/weewx.conf
|
||||
```
|
||||
|
||||
To install new skins, drivers, or other extensions, use the `weectl` utility
|
||||
and the URL to the extension.
|
||||
|
||||
```shell
|
||||
sudo weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
WeeWX must be restarted for the changes to take effect.
|
||||
```{.shell .copy}
|
||||
sudo systemctl restart weewx
|
||||
|
||||
@@ -70,13 +70,19 @@ To enable uploads or to customize reports, modify the configuration file.
|
||||
See the [*Customization Guide*](../custom/introduction.md) for instructions,
|
||||
and the [application](../reference/weewx-options/introduction.md) and
|
||||
[skin](../reference/skin-options/introduction.md) references for all
|
||||
the options.
|
||||
the options. Use any text editor, such as `nano`:
|
||||
|
||||
Use any text editor, such as `nano`:
|
||||
```shell
|
||||
sudo nano /etc/weewx/weewx.conf
|
||||
```
|
||||
|
||||
To install new skins, drivers, or other extensions, use the `weectl` utility
|
||||
and the URL to the extension.
|
||||
|
||||
```shell
|
||||
sudo weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
WeeWX must be restarted for the changes to take effect.
|
||||
```{.shell .copy}
|
||||
sudo systemctl restart weewx
|
||||
|
||||
@@ -130,3 +130,30 @@ weectl station reconfigure
|
||||
|
||||
See the documentation for [`weectl
|
||||
extension`](../utilities/weectl-extension.md) for details.
|
||||
|
||||
## Installing a skin, uploader or other extension
|
||||
|
||||
There are many skins and other extensions available that add features and
|
||||
functionality to the core WeeWX capabilities. Use the WeeWX extension
|
||||
management utility to download, install, and manage these extensions.
|
||||
|
||||
Start by looking in the extensions section of the
|
||||
[WeeWX Wiki](https;//github.com/weewx/weewx/wiki). When you find an
|
||||
extension you like, make note of the URL to that extension. The URL will refer
|
||||
to a `zip` or `tgz` file.
|
||||
|
||||
Then install the extension, using the URL:
|
||||
```
|
||||
weectl extension install https://github.com/path/to/extension.zip
|
||||
```
|
||||
|
||||
Some extensions work with no further changes required. Others might require
|
||||
changes to the WeeWX configuration file, for example, login credentials
|
||||
required to upload data to an MQTT broker. If so, modify the WeeWX
|
||||
configuration file using a text editor such as `nano`, and see the
|
||||
extension documentation for details.
|
||||
|
||||
In most cases, you will then have to restart `weewxd`.
|
||||
|
||||
See the documentation for [`weectl
|
||||
extension`](../utilities/weectl-extension.md) for details.
|
||||
|
||||
Reference in New Issue
Block a user