Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felddy/weewx-docker
Docker container for WeeWx weather station server
https://github.com/felddy/weewx-docker
container docker docker-container hacktoberfest weather weather-station weewx weewx-docker
Last synced: 8 days ago
JSON representation
Docker container for WeeWx weather station server
- Host: GitHub
- URL: https://github.com/felddy/weewx-docker
- Owner: felddy
- License: cc0-1.0
- Created: 2019-11-25T21:35:35.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-01T14:31:49.000Z (6 months ago)
- Last Synced: 2024-05-01T16:44:19.256Z (6 months ago)
- Topics: container, docker, docker-container, hacktoberfest, weather, weather-station, weewx, weewx-docker
- Language: Python
- Homepage: https://hub.docker.com/r/felddy/weewx
- Size: 934 KB
- Stars: 55
- Watchers: 4
- Forks: 38
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# weewx-docker 🌩🐳 #
[](https://github.com/felddy/weewx-docker/actions)
[](https://securityscorecards.dev/viewer/?uri=github.com/felddy/weewx-docker)
[](https://bestpractices.coreinfrastructure.org/projects/6003)
[](https://github.com/felddy/weewx-docker/actions/workflows/codeql-analysis.yml)
[](https://hub.docker.com/r/felddy/weewx)
[](https://hub.docker.com/r/felddy/weewx)
[](https://hub.docker.com/r/felddy/weewx)
[](https://hub.docker.com/r/felddy/weewx/tags)
This docker container can be used to quickly get a
[WeeWX](http://weewx.com) instance up and running.
This container has the following WeeWX extensions pre-installed:
- [interceptor](https://github.com/matthewwall/weewx-interceptor)
- [mqtt](https://github.com/weewx/weewx/wiki/mqtt)
## 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.
Modify any paths or devices as needed:
```yaml
---
version: "3.8"
volumes:
data:
services:
weewx:
image: felddy/weewx
init: true
restart: "yes"
volumes:
- type: bind
source: ./data
target: /data
environment:
- TIMEZONE=UTC
- WEEWX_UID=weewx
- WEEWX_GID=dialout
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
```
1. Create a directory on the host to store the configuration and database files:
```console
mkdir data
```
1. If this is the first time running weewx, use the following command to start
the container and generate a configuration file:
```console
docker compose run weewx
```
1. The configuration file will be created in the `data` directory. You should
edit this file to match the setup of your weather station.
1. When you are satisfied with configuration the container can be started in the
background with:
```console
docker compose up -d
```
## Upgrading ##
1. Stop the running container:
```console
docker compose down
```
1. Pull the new images from the Docker hub:
```console
docker compose pull
```
1. Update your configuration file (a backup will be created):
```console
docker compose run weewx --upgrade
```
1. Read through the new configuration and verify.
It is helpful to `diff` the new config with the backup. Check the
[WeeWX Upgrade Guide](http://weewx.com/docs/upgrading.htm#Instructions_for_specific_versions)
for instructions for specific versions.
1. Start the container up with the new image version:
```console
docker compose up -d
```
## Volumes ##
| Mount point | Purpose |
|-------------|----------------|
| `/data` | configuration file and sqlite database storage |
## Environment Variables ##
| Variable | Purpose | Default |
|----------------|---------|---------|
| `TIMEZONE` | Container [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) | `UTC` |
| `WEEWX_UID` | `uid` the daemon will be run under | `weewx` |
| `WEEWX_GID` | `gid` the deamon will be run under | `weewx` |
## Building from source ##
Build the image locally using this git repository as the [build context](https://docs.docker.com/engine/reference/commandline/build/#git-repositories):
```console
docker build \
--tag felddy/weewx:4.8.0 \
https://github.com/felddy/weewx-docker.git#develop
```
## Cross-platform builds ##
To create images that are compatible with other platforms you can use the
[`buildx`](https://docs.docker.com/buildx/working-with-buildx/) feature of
Docker:
1. Copy the project to your machine using the `Clone` button above
or the command line:
```console
git clone https://github.com/felddy/weewx-docker.git
cd weewx-docker
```
1. Build the image using `buildx`:
```console
docker buildx build \
--platform linux/amd64 \
--output type=docker \
--tag felddy/weewx:4.8.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
details.
## License ##
This project is in the worldwide [public domain](LICENSE).
This project is in the public domain within the United States, and
copyright and related rights in the work worldwide are waived through
the [CC0 1.0 Universal public domain
dedication](https://creativecommons.org/publicdomain/zero/1.0/).
All contributions to this project will be released under the CC0
dedication. By submitting a pull request, you are agreeing to comply
with this waiver of copyright interest.