{"id":13586095,"url":"https://github.com/felddy/weewx-docker","last_synced_at":"2025-03-15T13:31:05.590Z","repository":{"id":36411782,"uuid":"224046009","full_name":"felddy/weewx-docker","owner":"felddy","description":"Docker container for WeeWx weather station server","archived":false,"fork":false,"pushed_at":"2024-05-01T14:31:49.000Z","size":956,"stargazers_count":55,"open_issues_count":13,"forks_count":38,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2024-05-01T16:44:19.256Z","etag":null,"topics":["container","docker","docker-container","hacktoberfest","weather","weather-station","weewx","weewx-docker"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/felddy/weewx","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/felddy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["felddy"]}},"created_at":"2019-11-25T21:35:35.000Z","updated_at":"2024-08-01T16:32:08.005Z","dependencies_parsed_at":"2023-10-10T17:02:07.596Z","dependency_job_id":"93619675-34b2-490a-aa18-943e98026a86","html_url":"https://github.com/felddy/weewx-docker","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felddy%2Fweewx-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felddy%2Fweewx-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felddy%2Fweewx-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felddy%2Fweewx-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/felddy","download_url":"https://codeload.github.com/felddy/weewx-docker/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243735817,"owners_count":20339535,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container","docker","docker-container","hacktoberfest","weather","weather-station","weewx","weewx-docker"],"created_at":"2024-08-01T15:05:19.575Z","updated_at":"2025-03-15T13:31:05.583Z","avatar_url":"https://github.com/felddy.png","language":"Python","funding_links":["https://github.com/sponsors/felddy"],"categories":["Python"],"sub_categories":[],"readme":"# weewx-docker 🌩🐳 #\n\n[![GitHub Build Status](https://github.com/felddy/weewx-docker/workflows/Build/badge.svg)](https://github.com/felddy/weewx-docker/actions)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/felddy/weewx-docker/badge)](https://securityscorecards.dev/viewer/?uri=github.com/felddy/weewx-docker)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6003/badge)](https://bestpractices.coreinfrastructure.org/projects/6003)\n[![CodeQL](https://github.com/felddy/weewx-docker/workflows/CodeQL/badge.svg)](https://github.com/felddy/weewx-docker/actions/workflows/codeql-analysis.yml)\n[![WeeWX Version](https://img.shields.io/github/v/release/felddy/weewx-docker?color=brightgreen)](https://hub.docker.com/r/felddy/weewx)\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/felddy/weewx)](https://hub.docker.com/r/felddy/weewx)\n[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/felddy/weewx)](https://hub.docker.com/r/felddy/weewx)\n[![Platforms](https://img.shields.io/badge/platforms-amd64%20%7C%20arm%2Fv6%20%7C%20arm%2Fv7%20%7C%20arm64%20%7C%20ppc64le%20%7C%20s390x-blue)](https://hub.docker.com/r/felddy/weewx/tags)\n\nThis docker container can be used to quickly get a\n[WeeWX](http://weewx.com) instance up and running.\n\n## Running ##\n\nThe easiest way to start the container is to create a\n`docker-compose.yml` similar to the following.  If you use a\nserial port to connect to your weather station, make sure the\ncontainer has permissions to access the port.\n\nModify any paths or devices as needed:\n\n```yaml\n---\nname: \"weewx\"\n\nservices:\n  weewx:\n    image: felddy/weewx:5\n    volumes:\n      - type: bind\n        source: ./data\n        target: /data\n    devices:\n      - \"/dev/ttyUSB0:/dev/ttyUSB0\"\n```\n\n1. Create a directory on the host to store the configuration and database files:\n\n    ```console\n    mkdir data\n    ```\n\n1. If this is the first time running weewx, use the following command to start\n   the container and generate a configuration file:\n\n    ```console\n    docker compose run --rm weewx\n    ```\n\n1. The configuration file will be created in the `data` directory.  You should\n   edit this file to match the setup of your weather station.\n\n1. When you are satisfied with configuration the container can be started in the\n   background with:\n\n    ```console\n    docker compose up --detach\n    ```\n\n## Upgrading ##\n\n1. Stop the running container:\n\n    ```console\n    docker compose down\n    ```\n\n1. Pull the new images from the Docker hub:\n\n    ```console\n    docker compose pull\n    ```\n\n1. Update your configuration file (a backup will be created):\n\n    ```console\n    docker compose run --rm weewx station upgrade\n    ```\n\n1. Read through the new configuration and verify.\n   It is helpful to `diff` the new config with the backup.  Check the\n   [WeeWX Upgrade Guide](http://weewx.com/docs/upgrading.htm#Instructions_for_specific_versions)\n   for instructions for specific versions.\n\n1. Start the container up with the new image version:\n\n    ```console\n    docker compose up --detach\n    ```\n\n## Migrating ##\n\nIf you are migrating a WeeWX installation, you need to configure the logger to\nwrite to the console. Add the following to your `weewx.conf` file to see the log\noutput in the container logs:\n\n```ini\n[Logging]\n    [[root]]\n        level = INFO\n        handlers = console,\n```\n\n## Installing WeeWX Extensions ##\n\nIf arguments are passed to the container, they are forwarded on to the\n[`weectl`](https://weewx.com/docs/5.1/utilities/weectl-about/) command.  This\ncan be used to install extensions:\n\n```console\ndocker compose run --rm weewx \\\n  extension install --yes \\\n  https://github.com/matthewwall/weewx-windy/archive/master.zip\n```\n\n```console\ndocker compose run --rm weewx \\\n  extension install --yes \\\n  https://github.com/matthewwall/weewx-mqtt/archive/master.zip\n```\n\n## Installing Python Packages ##\n\nTo install and persist Python packages, use the `pip` command. The libraries\nwill be installed into the `data` volume, ensuring they persist between\ncontainer restarts.\n\n```console\ndocker compose run --rm --entrypoint pip weewx \\\n  install git+https://github.com/felddy/weewx-home-assistant@v1.0.0\n```\n\n## Image tags ##\n\nThe images of this container are tagged with [semantic\nversions](https://semver.org) that align with the [version and build of\nWeeWX](https://weewx.com/docs.html) that they support.\n\n\u003e [!TIP]\n\u003e It is recommended that users use the major version tag: `:5` Using the major\n\u003e tag will ensure that you receive the most recent version of the software that\n\u003e is compatible with your saved data, and prevents inadvertent upgrades to a new\n\u003e major version.\n\n| Image:tag | Description |\n|-----------|-------------|\n|`felddy/weewx:5`| The most recent image matching the major version number.  Most users will use this tag. |\n|`felddy/weewx:5.1`| The most recent image matching the major and minor version numbers. |\n|`felddy/weewx:5.1.0`| An exact image version. |\n\nSee the [tags tab](https://hub.docker.com/r/felddy/weewx/tags) on Docker\nHub for a list of all the supported tags.\n\n## Volumes ##\n\n| Mount point | Purpose        |\n|-------------|----------------|\n| `/data`     | [WeeWX root](https://weewx.com/docs/5.1/usersguide/where/#location-of-weewx-components) directory |\n\n## Building from source ##\n\nBuild the image locally using this git repository as the [build context](https://docs.docker.com/engine/reference/commandline/build/#git-repositories):\n\n```console\ndocker build \\\n  --tag felddy/weewx:5.1.0 \\\n  https://github.com/felddy/weewx-docker.git#develop\n```\n\n## Cross-platform builds ##\n\nTo create images that are compatible with other platforms you can use the\n[`buildx`](https://docs.docker.com/buildx/working-with-buildx/) feature of\nDocker:\n\n1. Copy the project to your machine using the `Clone` button above\n   or the command line:\n\n    ```console\n    git clone https://github.com/felddy/weewx-docker.git\n    cd weewx-docker\n    ```\n\n1. Build the image using `buildx`:\n\n    ```console\n    docker buildx build \\\n      --platform linux/amd64 \\\n      --output type=docker \\\n      --tag felddy/weewx:5.1.0 .\n    ```\n\n## Contributing ##\n\nWe welcome contributions!  Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for\ndetails.\n\n## License ##\n\nThis project is released as open source under the [MIT license](LICENSE).\n\nAll contributions to this project will be released under the same MIT license.\nBy submitting a pull request, you are agreeing to comply with this waiver of\ncopyright interest.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelddy%2Fweewx-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelddy%2Fweewx-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelddy%2Fweewx-docker/lists"}