Skip to content

Commit 97b3387

Browse files
committed
Prepare release 0.7.1 (#338)
* README: Use official docker image * CONTRIBUTING: Start using main instead of dev * CHANGELOG: Add version 0.7.1 * README: Section about systemd service
1 parent 5ad22fa commit 97b3387

File tree

3 files changed

+40
-22
lines changed

3 files changed

+40
-22
lines changed

CHANGELOG.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,28 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [Unreleased]
99

10+
## [0.7.1] - 2022-07-02
11+
12+
Howdy farmers! It's been a long while. This release brings everything from `dev` to `main` branch
13+
and going forward, all new development will happen directly on the `main` branch.
14+
15+
There's now an [official docker image](https://github.com/martomi/chiadog/pkgs/container/chiadog/versions) that will
16+
be published automatically with every new release. For the most stable experience, I recommend using the docker image
17+
or sticking to release tagged versions of the `main` branch.
18+
19+
### Added
20+
- Automated docker image builds - thanks [@Artanicus](https://github.com/Artanicus)!
21+
- Pushcut notifier - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
22+
- IFTTT notifier - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
23+
- Optional notification for plot increases - thanks [@Connor-Knabe](https://github.com/Connor-Knabe)!
24+
- Ability to run in sandboxed systemd service - thanks [@alexking](https://github.com/alexking)!
25+
- Option to disable SMPT Auth - thanks [@unsocial-bleach](https://github.com/unsocial-bleach)!
26+
- Config for log handlers and option to filter dust storm wallet events - thanks [@egeedot](https://github.com/egeedot) and [@martomi](https://github.com/martomi)!
27+
28+
### Fixed
29+
- Thanks [@kanasite](https://github.com/kanasite) for fixing the block parser and adding tests!
30+
31+
1032
## [0.7.0] - 2021-07-29
1133

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

198-
[Unreleased]: https://github.com/martomi/chiadog/compare/v0.7.0...dev
220+
[Unreleased]: https://github.com/martomi/chiadog/compare/v0.7.1...main
221+
222+
[0.7.1]: https://github.com/martomi/chiadog/compare/v0.7.0...v0.7.1
199223

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

CONTRIBUTING.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ You can open and edit the [architecture.drawio](./docs/architecture.drawio) file
1212
## How to contribute?
1313

1414
1. Fork the repository
15-
2. Create a feature or bugfix branch from `dev`
15+
2. Create a feature or bugfix branch from `main`
1616
3. Push your changes to the branch on your forked repository
17-
4. Submit a PR towards `dev` branch of this repository.
18-
19-
> Note: It's important to base your work on top of the `dev` branch. The `main` branch will only be
20-
> updated once a new release is ready to be pushed. I'll then be merging all changes from `dev` into `main`.
17+
4. Submit a PR towards `main` branch of this repository.
2118

2219
## Commit messages
2320

@@ -62,4 +59,4 @@ python3 -m unittest
6259
## Have fun
6360

6461
Most importantly: Have fun and if you're unsure about some contribution, don't shy away from submit a Pull Request
65-
anyway. We can use that as a basis for discussions, provide feedback and iterate on further improvements. Cheers!
62+
anyway. We can use that as a basis for discussions, provide feedback and iterate on further improvements. Cheers!

README.md

+12-15
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ one of your external HDDs disconnected and your harvester doesn't have access to
3838
## Access & Security
3939

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

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

9999
## Installation
100100

101+
### Recommended
102+
103+
The new recommended way of using `chiadog` is via the official [docker image](https://github.com/martomi/chiadog/pkgs/container/chiadog/versions).
104+
105+
### Manual Installation
106+
101107
_For updating from previous version, see section below._
102108

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

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

124-
## Updating to the latest release
130+
### Updating to the latest release
125131

126132
_Skip this if you followed the above section_.
127133

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

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

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

199-
You can also run chiadog as a sandboxed systemd service.
200-
201-
## Running `chiadog` in sandboxed environment
204+
## Running `chiadog` as sandboxed systemd service
202205

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

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

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

0 commit comments

Comments
 (0)