Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Bug report
about: Something went wrong while setting up or running RigForge
title: ''
labels: bug
assignees: ''
---

## What happened

A clear description of the bug — what you expected and what actually happened.

## Environment

- **OS / version:** (e.g. Ubuntu 22.04, Debian 12, macOS 14)
- **CPU:** (e.g. AMD Ryzen 9 7950X3D, EPYC 7402)
- **RigForge commit:** (output of `git rev-parse --short HEAD`)
- **Pool / stack:** (Pithead, or another RandomX pool)

## Steps to reproduce

1.
2.
3.

## Logs

Relevant output from the setup script and/or the miner. On Linux:

```
sudo journalctl -u xmrig --no-pager | tail -n 50
```

<details>
<summary>Logs</summary>

```
paste logs here
```

</details>

## Additional context

Anything else that might help (BIOS/Secure Boot settings, HugePages state from
`grep Huge /proc/meminfo`, etc.).
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Pithead (P2Pool stack) questions
url: https://github.com/p2pool-starter-stack/pithead/issues
about: >-
For questions about the P2Pool stack itself — the Monero node, P2Pool,
xmrig-proxy, payouts, or dashboard — please open an issue on the Pithead
repo. RigForge issues here should be about the miner/worker setup.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an improvement or a new capability for RigForge
title: ''
labels: enhancement
assignees: ''
---

## Problem / motivation

What are you trying to do that RigForge doesn't handle well today?

## Proposed solution

What you'd like to see. If it's a new CPU tuning profile, include the CPU model
and any reference numbers.

## Alternatives considered

Other approaches you thought about, and why they fall short.

## Additional context

Anything else — links, related issues, or notes on portability across
Ubuntu/Debian/macOS.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## What & why

<!-- What does this change do, and why? Link any related issue (e.g. Closes #10). -->

## Checklist

- [ ] `shellcheck rigforge.sh util/proposed-grub.sh` passes locally
- [ ] Changes are portable bash (Ubuntu/Debian and macOS)
- [ ] Docs updated (README / other) if behaviour or options changed
- [ ] PR is focused and ready for review
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contributing to RigForge

Thanks for your interest in improving RigForge! Whether it's a bug fix, a new
CPU tuning profile, or a docs tweak, contributions are welcome.

RigForge is the companion miner for the
[Pithead](https://github.com/p2pool-starter-stack/pithead) P2Pool stack. If your
idea is really about the stack as a whole rather than the miner, that repo may be
the better home for it.

## Before you start

- For anything beyond a small fix, **open an issue first** so we can agree on the
approach before you spend time on it. This avoids duplicated or wasted effort.
- Check the existing issues to see if someone is already on it.

## Making changes

RigForge is portable Bash that has to run on Ubuntu/Debian and macOS, so:

- Keep it **portable bash** — avoid GNU-only flags and other Linux-isms where a
POSIX-friendly alternative exists, and guard platform-specific code paths.
- Run **ShellCheck** before you push and fix any warnings:

```bash
shellcheck rigforge.sh util/proposed-grub.sh
```

CI runs the same check, so a clean local run keeps your PR green.
- Update the README or other docs when you change behaviour or add options.

## Submitting a pull request

1. Fork the repo and create a topic branch off `main`.
2. Make your change and confirm `shellcheck` passes.
3. Open a PR against `main` and fill out the template.
4. **All PRs require review** before merging — a code owner will take a look.

Keep PRs focused and the description clear about *what* changed and *why*. Small,
reviewable changes get merged faster.

Thanks again for contributing! 🔥
29 changes: 29 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Security Policy

RigForge compiles XMRig from upstream source and applies privileged system
tuning — it runs as root, configures kernel HugePages and MSR access, and
installs a `systemd` service. Because of that footprint, we take security
reports seriously and appreciate responsible disclosure.

## Supported versions

Only the latest `main` is supported. Please reproduce against current `main`
before reporting.

| Version | Supported |
|----------------|-----------|
| `main` (latest)| ✅ |
| older commits | ❌ |

## Reporting a vulnerability

**Please do not open a public issue for security problems.**

Instead, use GitHub's private vulnerability reporting on this repository:

1. Go to the **Security** tab.
2. Click **Report a vulnerability** (under *Security Advisories*).
3. Describe the issue, the affected version/commit, and steps to reproduce.

We'll acknowledge your report, investigate, and keep you updated on a fix and
disclosure timeline. Thanks for helping keep RigForge users safe.
Loading