Skip to content

Commit

Permalink
Add docs on systemd service for foxy-farmer
Browse files Browse the repository at this point in the history
  • Loading branch information
felixbrucker committed Oct 30, 2023
1 parent 857e243 commit 727efcd
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/proof-of-spacetime/foxy-farmer/setup-systemd-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
To run Foxy-Farmer as a systemd service, a template `foxy-farmer.service` file is provided in the [root of the repo](https://github.com/foxypool/foxy-farmer/blob/main/foxy-farmer.service){target=_blank}.

1. Copy the template `foxy-farmer.service` into `/etc/systemd/system/foxy-farmer.service`
2. Modify the `User` and `Group` to your user/group.
3. Modify the path to the `foxy-farmer` binary as well as the path to the `foxy-farmer.yaml` to fit your paths.

!!! note
When running from source the binary path is in `venv/bin/`, so for example `/home/user/foxy-farmer/venv/bin/foxy-farmer`.

4. Reload the daemon to detect your new service:
```bash
sudo systemctl daemon-reload
```
5. Enable the service to start on boot:
```bash
sudo systemctl enable foxy-farmer.service
```
6. Start the service:
```bash
sudo service foxy-farmer start
```


### Using

- The status of the service can be seen via:
```bash
sudo service foxy-farmer status
```
- You can stop the service via:
```bash
sudo service foxy-farmer stop
```
- You can tail the logs of the service via:
```bash
sudo journalctl -u foxy-farmer.service --follow
```
37 changes: 37 additions & 0 deletions docs/proof-of-spacetime/foxy-gh-farmer/setup-systemd-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
To run Foxy-GH-Farmer as a systemd service, a template `foxy-gh-farmer.service` file is provided in the [root of the repo](https://github.com/foxypool/foxy-gh-farmer/blob/main/foxy-gh-farmer.service){target=_blank}.

1. Copy the template `foxy-gh-farmer.service` into `/etc/systemd/system/foxy-gh-farmer.service`
2. Modify the `User` and `Group` to your user/group.
3. Modify the path to the `foxy-gh-farmer` binary as well as the path to the `foxy-gh-farmer.yaml` to fit your paths.

!!! note
When running from source the binary path is in `venv/bin/`, so for example `/home/user/foxy-gh-farmer/venv/bin/foxy-gh-farmer`.

4. Reload the daemon to detect your new service:
```bash
sudo systemctl daemon-reload
```
5. Enable the service to start on boot:
```bash
sudo systemctl enable foxy-gh-farmer.service
```
6. Start the service:
```bash
sudo service foxy-gh-farmer start
```


### Using

- The status of the service can be seen via:
```bash
sudo service foxy-gh-farmer status
```
- You can stop the service via:
```bash
sudo service foxy-gh-farmer stop
```
- You can tail the logs of the service via:
```bash
sudo journalctl -u foxy-gh-farmer.service --follow
```
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,12 @@ nav:
- proof-of-spacetime/foxy-farmer/index.md
- Installing: proof-of-spacetime/foxy-farmer/installing.md
- Configuration: proof-of-spacetime/foxy-farmer/configuration.md
- Systemd service: proof-of-spacetime/foxy-farmer/setup-systemd-service.md
- Foxy-GH-Farmer:
- proof-of-spacetime/foxy-gh-farmer/index.md
- Installing: proof-of-spacetime/foxy-gh-farmer/installing.md
- Configuration: proof-of-spacetime/foxy-gh-farmer/configuration.md
- Systemd service: proof-of-spacetime/foxy-gh-farmer/setup-systemd-service.md
- Chia Farming Gateway:
- proof-of-spacetime/chia-farming-gateway/index.md
- Monitoring apps:
Expand Down

0 comments on commit 727efcd

Please sign in to comment.