Skip to content

Commit

Permalink
Prepare release 0.7.1 (#338)
Browse files Browse the repository at this point in the history
* README: Use official docker image

* CONTRIBUTING: Start using main instead of dev

* CHANGELOG: Add version 0.7.1

* README: Section about systemd service
  • Loading branch information
martomi committed Jul 2, 2022
1 parent 5ad22fa commit 97b3387
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 22 deletions.
26 changes: 25 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,28 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.7.1] - 2022-07-02

Howdy farmers! It's been a long while. This release brings everything from `dev` to `main` branch
and going forward, all new development will happen directly on the `main` branch.

There's now an [official docker image](https://github.com/martomi/chiadog/pkgs/container/chiadog/versions) that will
be published automatically with every new release. For the most stable experience, I recommend using the docker image
or sticking to release tagged versions of the `main` branch.

### Added
- Automated docker image builds - thanks [@Artanicus](https://github.com/Artanicus)!
- Pushcut notifier - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
- IFTTT notifier - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
- Optional notification for plot increases - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
- Ability to run in sandboxed systemd service - thanks [@alexking](https://github.com/alexking)!
- Option to disable SMPT Auth - thanks [@unsocial-bleach](https://github.com/unsocial-bleach)!
- Config for log handlers and option to filter dust storm wallet events - thanks [@egeedot](https://github.com/egeedot) and [@martomi](https://github.com/martomi)!

### Fixed
- Thanks [@kanasite](https://github.com/kanasite) for fixing the block parser and adding tests!


## [0.7.0] - 2021-07-29

This release adds support for pooling!
Expand Down Expand Up @@ -195,7 +217,9 @@ The purpose of this minor release is to get out a few fixes. No new features in
- Adds basic condition checks for harvester operations.
- Adds integration for Pushover (mobile notifications).

[Unreleased]: https://github.com/martomi/chiadog/compare/v0.7.0...dev
[Unreleased]: https://github.com/martomi/chiadog/compare/v0.7.1...main

[0.7.1]: https://github.com/martomi/chiadog/compare/v0.7.0...v0.7.1

[0.7.0]: https://github.com/martomi/chiadog/compare/v0.6.1...v0.7.0

Expand Down
9 changes: 3 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@ You can open and edit the [architecture.drawio](./docs/architecture.drawio) file
## How to contribute?

1. Fork the repository
2. Create a feature or bugfix branch from `dev`
2. Create a feature or bugfix branch from `main`
3. Push your changes to the branch on your forked repository
4. Submit a PR towards `dev` branch of this repository.

> Note: It's important to base your work on top of the `dev` branch. The `main` branch will only be
> updated once a new release is ready to be pushed. I'll then be merging all changes from `dev` into `main`.
4. Submit a PR towards `main` branch of this repository.

## Commit messages

Expand Down Expand Up @@ -62,4 +59,4 @@ python3 -m unittest
## Have fun

Most importantly: Have fun and if you're unsure about some contribution, don't shy away from submit a Pull Request
anyway. We can use that as a basis for discussions, provide feedback and iterate on further improvements. Cheers!
anyway. We can use that as a basis for discussions, provide feedback and iterate on further improvements. Cheers!
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ one of your external HDDs disconnected and your harvester doesn't have access to
## Access & Security

It only requires read-access to your `debug.log` file and internet connection to send out notifications. It's highly
recommended that you run `chiadog` in a sandboxed environment - this is described in the advanced section below.
recommended that you run `chiadog` in a sandboxed environment. Please use the official [docker image](https://github.com/martomi/chiadog/pkgs/container/chiadog/versions).

Furthermore, following best security practices, you
should [keep your wallet separate](https://github.com/Chia-Network/chia-blockchain/wiki/Good-Security-Practices-on-Many-Machines#keep-your-wallet-separate).
Expand Down Expand Up @@ -98,6 +98,12 @@ cat ~/.chia/mainnet/log/debug.log

## Installation

### Recommended

The new recommended way of using `chiadog` is via the official [docker image](https://github.com/martomi/chiadog/pkgs/container/chiadog/versions).

### Manual Installation

_For updating from previous version, see section below._

1. Clone the repository
Expand All @@ -121,7 +127,7 @@ cp config-example.yaml config.yaml

4. Open up `config.yaml` in your editor and configure it to your preferences.

## Updating to the latest release
### Updating to the latest release

_Skip this if you followed the above section_.

Expand Down Expand Up @@ -176,8 +182,7 @@ keep-alive event from the harvester.
## Redundant monitoring for `chiadog`

There are failure-cases in which `chiadog` is helpless. For example, your computer completely freezes or shuts down.
Perhaps your entire home network goes down.
`chiadog` won't be able to send you a notification.
Perhaps your entire home network goes down. `chiadog` won't be able to send you a notification.

There's a way however: in the [config](config-example.yaml) under the section of `keep_alive_monitor`, you can enable
pinging to a remote service that will act as a watchdog of `chiadog`. A second level of redundancy, if you wish!
Expand All @@ -196,19 +201,11 @@ nohup python3 -u main.py --config config.yaml > output.log 2>&1 &
To stop chiadog, you can find the Process ID (PID) via `ps aux | grep main.py` and then softly interrupt the process
with `kill -SIGINT <pid_here>`.

You can also run chiadog as a sandboxed systemd service.

## Running `chiadog` in sandboxed environment
## Running `chiadog` as sandboxed systemd service

We're still exploring the best way to provide easy to setup sandboxed environment where the `chiadog` process is
completely isolated from potentially accessing your private keys. Contributions in that direction are very welcome.
Alternatively to the original chiadog docker image, you can setup a [systemd service](scripts/linux/chiadog.service)
which runs chiadog as a limited user and blocks access to key chia locations.

* There is an example [systemd service](scripts/linux/chiadog.service) you can configure which runs chiadog as a limited
user and blocks access to key chia locations.
* Alternatively, [as suggested here](https://github.com/martomi/chiadog/issues/24) you can run `chiadog` from a unix
user with limited permissions.
* For running in docker, you can check out @ajacobson repository for
[chiadog-docker](https://github.com/ajacobson/chiadog-docker).
# Contributing

Contributions are always welcome! Please refer to [CONTRIBUTING](CONTRIBUTING.md) documentation.

0 comments on commit 97b3387

Please sign in to comment.