Skip to content
Merged
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
42 changes: 21 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Report Bug
description: Create a bug report.
description: Submit a bug report to help improve CoreMiner.
title: "[BUG] "
labels:
- bug
Expand All @@ -9,18 +9,18 @@ body:
- type: markdown
attributes:
value: |
Please, provide as much details as possible to make proper evaluation and in the end resolve the bug report faster.
Please provide as many details as possible to help us evaluate and resolve the bug report efficiently.

- type: markdown
attributes:
value: |
Hardware details.
Hardware Information

- type: input
id: device
attributes:
label: Device
description: Used device.
description: Device being used
placeholder: Device name

- type: dropdown
Expand All @@ -40,69 +40,69 @@ body:
- type: input
id: cpubrand
attributes:
label: CPU brand
description: Brand of used CPU.
label: CPU Brand
description: CPU brand being used
placeholder: CPU brand

- type: input
id: cpumodel
attributes:
label: CPU model
description: Model of used CPU.
label: CPU Model
description: CPU model being used
placeholder: CPU model

- type: markdown
attributes:
value: |
Software specific details.
Software Information

- type: input
id: os
attributes:
label: OS and version
description: Name and version of OS used.
label: OS and Version
description: Operating system and version being used
placeholder: OS
validations:
required: true

- type: input
id: version
attributes:
label: Software version
description: Version of software used.
label: Software Version
description: Version of CoreMiner being used
placeholder: Version
validations:
required: true

- type: textarea
id: bug
attributes:
label: Bug
description: Describe the Bug.
label: Bug Description
description: Describe the bug in detail
placeholder: Bug description
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Reproduce Bug
description: Steps to reproduce the behavior.
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: 1. Step 1
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: Describe the result you are expecting.
label: Expected Behavior
description: Describe the expected result
placeholder: Result
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional context
description: Please, place additional content or screenshots.
label: Additional Context
description: Add any additional information or screenshots
11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ blank_issues_enabled: false
contact_links:
- name: Community Discussion
url: https://github.com/catchthatrabbit/coreminer/discussions
about: Discussion about mining on the Core Blockchain.
- name: Quick Start
about: Join discussions about mining on the Core Blockchain
- name: Quick Start Guide
url: https://catchthatrabbit.com/start-mining
about: To start mining, please follow this guide.
about: Follow our step-by-step guide to start mining
- name: Add Miner to Profitability Calculator
url: https://github.com/catchthatrabbit/ctr-web/edit/master/src/constants/machines.ts
about: Add your miner to CTR's profitability calculator
- name: Support
url: https://catchthatrabbit.com/contact
about: Contact support.
about: Get help from our support team
26 changes: 13 additions & 13 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature request
description: Suggest an idea for this project.
name: Feature Request
description: Suggest a new feature or enhancement for CoreMiner.
title: "[FEATURE] "
labels:
- feature
Expand All @@ -9,38 +9,38 @@ body:
- type: markdown
attributes:
value: |
Suggest an idea for this project and developers will consider the integration.
Suggest a new feature or enhancement for CoreMiner. Our development team will review your proposal.

- type: textarea
id: problem
attributes:
label: Problem
description: Is your feature request related to a problem? Please describe.
label: Problem Statement
description: What problem are you trying to solve?
validations:
required: true

- type: textarea
id: solution
attributes:
label: Solution
description: Describe the solution you'd like.
label: Proposed Solution
description: Describe your proposed solution
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe alternatives you've considered.
label: Alternative Solutions
description: What alternatives have you considered?

- type: textarea
id: implementation
attributes:
label: Implementation
description: Describe implementation with example of the code.
label: Implementation Details
description: Provide implementation details or code examples

- type: textarea
id: additional
attributes:
label: Additional context
description: Please, place additional content or screenshots.
label: Additional Information
description: Add any relevant information or screenshots
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
matrix:
config: [
{os: ubuntu-latest, path: linux-x86_64},
{os: raspbian-private, path: linux-arm64},
{os: ubuntu-24.04-arm, path: linux-arm64},
]
runs-on: ${{matrix.config.os}}
steps:
Expand Down Expand Up @@ -63,7 +63,7 @@ jobs:
matrix:
config: [
{os: ubuntu-latest, path: linux-x86_64},
{os: raspbian-private, path: linux-arm64},
{os: ubuntu-24.04-arm, path: linux-arm64},
]
runs-on: ${{matrix.config.os}}
needs: release
Expand Down
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

76 changes: 61 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,25 @@

## Table of Contents

* [Install](#install)
* [Manual Installation](#manual-installation)
* [Automatic Installation](#automatic-installation)
* [Usage](#usage)
* [Limitations](#limitations)
* [Post-installation steps](#post-installation-steps)
* [Config file](#config-file)
* [Build](#build)
* [Pools](#pools)
- [Core Miner](#core-miner)
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Manual Installation](#manual-installation)
- [Automatic Installation](#automatic-installation)
- [Pre-requirements](#pre-requirements)
- [Execution](#execution)
- [Cloud Deployment](#cloud-deployment)
- [Usage](#usage)
- [How to start mining](#how-to-start-mining)
- [Standalone](#standalone)
- [Limitations](#limitations)
- [Post-installation steps](#post-installation-steps)
- [Config file](#config-file)
- [Build](#build)
- [Building from source](#building-from-source)
- [API documentation](#api-documentation)
- [Pools](#pools)
- [License](#license)

## Install

Expand Down Expand Up @@ -47,6 +57,43 @@ bash <(curl -s https://raw.githubusercontent.com/catchthatrabbit/coreminer/maste

After the installation completes, we recommend proceeding with the [post-installation steps](docs/AUTOSTART-LINUX.md) to ensure continuous high availability.

### Cloud Deployment

You can deploy CoreMiner to cloud instances using cloud-init. This method is particularly useful for automated deployments and scaling.

Create a `cloud-init-coreminer.yaml` file with the following configuration:

```yaml
# Define your Coreminer environment variables here
write_files:
- path: /etc/coreminer_env
permissions: '0644'
content: |
COREID=your_core_id_here
WORKER=your_worker_name_here
SERVER1=fi
SERVER2=de
```

The cloud-init configuration:

1. Updates system packages
2. Sets up environment variables for your CoreMiner configuration
3. Creates a systemd service for automatic startup
4. Installs required dependencies
5. Clones the CoreMiner repository
6. Configures the mining pool settings
7. Enables and starts the CoreMiner service

To use this configuration:

1. Replace `your_core_id_here` with your CoreMiner wallet address
2. Replace `your_worker_name_here` with your desired worker name
3. Adjust the server locations (`SERVER1`, `SERVER2`) as needed
4. Use this configuration when launching your cloud instance

## Usage

The **CoreMiner** is a command line program. This means you launch it either
Expand Down Expand Up @@ -88,6 +135,7 @@ Follow the [post-installation steps](docs/AUTOSTART-LINUX.md) from documentation
After running the `mine.sh` in the same folder produced setting file `pool.cfg`.

This file is loaded from two possible sources:

1. Same directory as `mine.sh` file with name `pool.cfg`.
1. Connected flash drive named `coredrive` and `pool.cfg` is located in the root folder.

Expand All @@ -96,13 +144,13 @@ Example of the contents of `pool.cfg` file:
```bash
wallet=cb…
worker=Rabbit
server[1]=eu.catchthatrabbit.com
server[1]=fi.catchthatrabbit.com
port[1]=8008
server[2]=as.catchthatrabbit.com
server[2]=de.catchthatrabbit.com
port[2]=8008
server[3]=eu1.catchthatrabbit.com
server[3]=sg.catchthatrabbit.com
port[3]=8008
server[4]=as1.catchthatrabbit.com
server[4]=hk.catchthatrabbit.com
port[4]=8008
```

Expand All @@ -125,5 +173,3 @@ Read more about [Stratum server](docs/STRATUM.md) in the documentation.
## License

Licensed under the [GNU General Public License, Version 3](LICENSE).

*Cryptoni confidimus*
62 changes: 62 additions & 0 deletions cloud-init-coreminer.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
#cloud-config
package_update: true
package_upgrade: true

# Define your Coreminer environment variables here
write_files:
- path: /etc/coreminer_env
permissions: '0644'
content: |
COREID=your_core_id_here
WORKER=your_worker_name_here
SERVER1=fi
SERVER2=de

- path: /etc/systemd/system/coreminer.service
permissions: '0644'
content: |
[Unit]
Description=Coreminer Service
After=network.target

[Service]
EnvironmentFile=/etc/coreminer_env
ExecStart=/usr/bin/coreminer --wallet ${COREID} --name ${WORKER}
WorkingDirectory=/usr/bin/
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

runcmd:
- |
if [ -f /var/log/coreminer_installed ]; then
echo "Coreminer already installed. Skipping setup."
exit 0
fi

- source /etc/coreminer_env
- apt update && apt install -y git wget curl unzip screen
- git clone https://github.com/catchthatrabbit/coreminer.git /opt/coreminer
- cp /opt/coreminer/coreminer /usr/bin/coreminer
- chmod +x /usr/bin/coreminer

- |
cat <<EOF > /usr/bin/pool.cfg
wallet=${COREID}
worker=${WORKER}
server[1]=${SERVER1}.catchthatrabbit.com
port[1]=8008
server[2]=${SERVER2}.catchthatrabbit.com
port[2]=8008
EOF

- chmod 644 /usr/bin/pool.cfg

- systemctl daemon-reexec
- systemctl daemon-reload
- systemctl enable coreminer.service
- systemctl start coreminer.service

- touch /var/log/coreminer_installed
2 changes: 1 addition & 1 deletion cmake/Hunter/config.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ hunter_config(
Boost
VERSION 1.79.0_new_url
SHA1 28b4c71b7d9b8e323d40748f14e5c6d390e19720
URL https://boostorg.jfrog.io/artifactory/main/release/1.79.0/source/boost_1_79_0.tar.gz
URL https://archives.boost.io/release/1.79.0/source/boost_1_79_0.tar.gz
CMAKE_ARGS USE_CONFIG_FROM_BOOST=ON Boost_USE_STATIC_LIBS=OFF Boost_USE_STATIC_RUNTIME=OFF
)
Loading