diff --git a/docs_src/quickstarts/debian.md b/docs_src/quickstarts/debian.md index e7803584..c07bcb6c 100644 --- a/docs_src/quickstarts/debian.md +++ b/docs_src/quickstarts/debian.md @@ -82,24 +82,26 @@ sudo systemctl start weewx ## Customize -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`: +To enable uploads, or to enable other reports, modify the configuration file +`/etc/weewx/weewx.conf` using any text editor such as `nano`: ```{.shell .copy} sudo nano /etc/weewx/weewx.conf ``` -To install new skins, drivers, or other extensions, use the `weectl` utility -and the URL to the extension. +See the [*User's Guide*](../usersguide/introduction.md) and the reference +[*The configuration file +weewx.conf*](../reference/weewx-options/introduction.md) for +instructions. -```{.shell} -sudo weectl extension install https://github.com/path/to/extension.zip -``` +For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the [reference for skin +options](../reference/skin-options/introduction.md). + +To install new skins, drivers, or other extensions, use the utility [`weectl +extension`](../utilities/weectl-extension.md). -WeeWX must be restarted for the changes to take effect. +WeeWX must be restarted for any changes to take effect. ```{.shell .copy} sudo systemctl restart weewx ``` diff --git a/docs_src/quickstarts/git.md b/docs_src/quickstarts/git.md index 3be02715..cbfeef85 100644 --- a/docs_src/quickstarts/git.md +++ b/docs_src/quickstarts/git.md @@ -128,22 +128,24 @@ If you have problems, check the system log for entries from `weewxd`. ## Customize -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`: +To enable uploads, or to enable other reports, modify the configuration file +`~/weewx-data/weewx.conf` using any text editor such as `nano`: ```{.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. +See the [*User's Guide*](../usersguide/introduction.md) and the reference +[*The configuration file +weewx.conf*](../reference/weewx-options/introduction.md) for +instructions. -```{.shell .copy} -weectl extension install https://github.com/path/to/extension.zip -``` +For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the [reference for skin +options](../reference/skin-options/introduction.md). + +To install new skins, drivers, or other extensions, use the utility [`weectl +extension`](../utilities/weectl-extension.md). The executable `weewxd` must be restarted for the changes to take effect. diff --git a/docs_src/quickstarts/pip.md b/docs_src/quickstarts/pip.md index 75fd61c5..668b9d27 100644 --- a/docs_src/quickstarts/pip.md +++ b/docs_src/quickstarts/pip.md @@ -1,8 +1,8 @@ # Installation using pip -This is a guide to installing WeeWX using [`pip`](https://pip.pypa.io). It can be -used on almost any operating system (including macOS) that offers Python v3.7 or -greater. Python 2, or earlier versions of Python 3, will not work. +This is a guide to installing WeeWX using [`pip`](https://pip.pypa.io). It can +be used on almost any operating system (including macOS) that offers Python +v3.7 or greater. Python 2, or earlier versions of Python 3, will not work. Although you do not need root privileges to install and configure WeeWX using `pip`, you will need them to set up a daemon, and you may need them to change @@ -167,8 +167,8 @@ only after you run `weewxd`, as shown in the following step. ## Run `weewxd` -The program `weewxd` does the data collection, archiving, uploading, and report -generation. You can run it directly, or as a daemon. +The program `weewxd` does the data collection, archiving, uploading, and +report generation. You can run it directly, or as a daemon. ### Run directly @@ -296,22 +296,24 @@ probably want to switch to using real hardware. This is how to reconfigure. ## Customize -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`: +To enable uploads, or to enable other reports, modify the configuration file +`~/weewx-data/weewx.conf` using any text editor such as `nano`: -```shell +```{.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. +See the [*User's Guide*](../usersguide/introduction.md) and the reference +[*The configuration file +weewx.conf*](../reference/weewx-options/introduction.md) for +instructions. -```shell -weectl extension install https://github.com/path/to/extension.zip -``` +For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the [reference for skin +options](../reference/skin-options/introduction.md). + +To install new skins, drivers, or other extensions, use the utility [`weectl +extension`](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. @@ -347,7 +349,7 @@ source ~/weewx-venv/bin/activate python3 -m pip install weewx --upgrade ``` -Optional: You may want to upgrade your documentation and examples. +Optional: You may want to upgrade examples and utility files: ``` weectl station upgrade --what examples util ``` @@ -402,7 +404,8 @@ To delete the applications and code, remove the WeeWX virtual environment: rm -r ~/weewx-venv ``` -Finally, if desired, to delete the database, skins, and other utilities, remove the data directory: +Finally, if desired, to delete the database, skins, and other utilities, +remove the data directory: ```{ .shell .copy } rm -r ~/weewx-data diff --git a/docs_src/quickstarts/redhat.md b/docs_src/quickstarts/redhat.md index c218eb65..078222f0 100644 --- a/docs_src/quickstarts/redhat.md +++ b/docs_src/quickstarts/redhat.md @@ -76,22 +76,24 @@ sudo systemctl start weewx ## Customize -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`: +To enable uploads, or to enable other reports, modify the configuration file +`/etc/weewx/weewx.conf` using any text editor such as `nano`: ```{.shell .copy} sudo nano /etc/weewx/weewx.conf ``` -To install new skins, drivers, or other extensions, use the `weectl` utility -and the URL to the extension. +See the [*User's Guide*](../usersguide/introduction.md) and the reference +[*The configuration file +weewx.conf*](../reference/weewx-options/introduction.md) for +instructions. -```{.shell} -sudo weectl extension install https://github.com/path/to/extension.zip -``` +For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the [reference for skin +options](../reference/skin-options/introduction.md). + +To install new skins, drivers, or other extensions, use the utility [`weectl +extension`](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. ```{.shell .copy} diff --git a/docs_src/quickstarts/suse.md b/docs_src/quickstarts/suse.md index 1b11cd14..45d2b80e 100644 --- a/docs_src/quickstarts/suse.md +++ b/docs_src/quickstarts/suse.md @@ -76,22 +76,24 @@ sudo systemctl start weewx ## Customize -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`: +To enable uploads, or to enable other reports, modify the configuration file +`/etc/weewx/weewx.conf` using any text editor such as `nano`: ```{.shell .copy} sudo nano /etc/weewx/weewx.conf ``` -To install new skins, drivers, or other extensions, use the `weectl` utility -and the URL to the extension. +See the [*User's Guide*](../usersguide/introduction.md) and the reference +[*The configuration file +weewx.conf*](../reference/weewx-options/introduction.md) for +instructions. -```{.copy} -sudo weectl extension install https://github.com/path/to/extension.zip -``` +For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the [reference for skin +options](../reference/skin-options/introduction.md). + +To install new skins, drivers, or other extensions, use the utility [`weectl +extension`](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. ```{.shell .copy} diff --git a/docs_src/reference/weewx-options/introduction.md b/docs_src/reference/weewx-options/introduction.md index 9fac8858..4b97fddf 100644 --- a/docs_src/reference/weewx-options/introduction.md +++ b/docs_src/reference/weewx-options/introduction.md @@ -1,4 +1,4 @@ -# Application options +# The configuration file weewx.conf Application options are specified in a configuration file, nominally called `weewx.conf`. This is a big text file, which holds the configuration