Skip to content

Commit

Permalink
Align documentation with reality
Browse files Browse the repository at this point in the history
  • Loading branch information
felddy committed Dec 4, 2024
1 parent 93e1d09 commit 0a49edd
Showing 1 changed file with 14 additions and 37 deletions.
51 changes: 14 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,10 @@ This docker container can be used to quickly get a

## Running ##

### Running with Docker ###

Pull `felddy/weewx` from the Docker repository:

```console
docker pull felddy/weewx
```

### Run ###

The easiest way to start the container is to create a
`docker-compose.yml` similar to the following. If you use a
serial port to connect to your weather station, make sure the
container has permissions to access the port. The uid/gid can
be set using the environment variables below.
container has permissions to access the port.

Modify any paths or devices as needed:

Expand Down Expand Up @@ -105,6 +94,19 @@ services:
docker compose up -d
```

## Migrating ##

If you are migrating from a non-containerized WeeWX installation, you will need to
configure the logger to write to the console. Adding the following your `weewx.conf`
will allow you to see the log output:

```ini
[Logging]
[[root]]
level = INFO
handlers = console,
```

## Installing WeeWX Extensions ##

```console
Expand All @@ -125,19 +127,6 @@ docker compose run --rm weewx \
docker compose run --rm --entrypoint pip weewx install paho_mqtt
```

## Migrating ##

If you are migrating from a non-containerized WeeWX installation, you will need to
configure the logger to write to the console. Adding the following your `weewx.conf`
will allow you to see the log output:

```ini
[Logging]
[[root]]
level = INFO
handlers = console,
```

## Volumes ##

| Mount point | Purpose |
Expand Down Expand Up @@ -177,18 +166,6 @@ Docker:
--tag felddy/weewx:5.1.0 .
```

## Debugging ##

There are a few helper arguments that can be used to diagnose container issues
in your environment.

| Purpose | Command |
|---------|---------|
| Generate the default configuration | `docker compose run weewx` |
| Upgrade a previous configuration | `docker compose run weewx --upgrade` |
| Generate a test (simulator) configuration | `docker compose run weewx --gen-test-config` |
| Drop into a shell in the container | `docker compose run weewx --shell` |

## Contributing ##

We welcome contributions! Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for
Expand Down

0 comments on commit 0a49edd

Please sign in to comment.