merge

README.md

@@ -0,0 +1,61 @@
+# all content in pages was generated by AI to fill out the space. We must replace it accordingly.
+
+# Megawatt Manual
+
+This repository contains the comprehensive documentation for setting up, operating, and maintaining our bitcoin mining facility. The manual covers everything from hardware and software setup to maintenance and troubleshooting.
+
+## Table of Contents
+- [all content in pages was generated by AI to fill out the space. We must replace it accordingly.](#all-content-in-pages-was-generated-by-ai-to-fill-out-the-space-we-must-replace-it-accordingly)
+- [Megawatt Manual](#megawatt-manual)
+  - [Table of Contents](#table-of-contents)
+  - [Introduction](#introduction)
+  - [Dependencies](#dependencies)
+  - [Installation](#installation)
+  - [Usage](#usage)
+
+## Introduction
+We are a small bitcoin mining facility with 10 tanks containing varying numbers of Antminer S19s (including k pro, j pro xp, and j models). We use Foreman (foreman.mn) to monitor our farm and Slack for communication. Our infrastructure includes a storage container and two different facilities: one for storage and a primary facility for repairs (fans, chip swaps, cleanings, merges).
+
+## Dependencies
+To build and serve the documentation, you need to have the following dependencies installed:
+
+1. **Python** (3.6 or higher)
+2. **pip** (Python package installer)
+3. **MkDocs** (A static site generator)
+4. **MkDocs Material Theme** (Theme for MkDocs)
+
+## Installation
+Follow these steps to set up the documentation locally:
+
+1. **Clone the Repository:**
+   ```bash
+   git clone https://github.com/yourusername/megawatt-manual.git
+   cd megawatt-manual
+
+2. **Create a Virtual Environment:**
+
+    ```bash
+    python -m venv venv
+    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+
+3. **Install Dependencies:**
+
+    ```bash
+    pip install mkdocs mkdocs-material
+
+## Usage
+To serve the documentation locally and view it in your browser, run:
+
+  ~~~
+  mkdocs serve
+  ~~~
+
+This will start a local server at http://127.0.0.1:8000 where you can view the documentation.
+
+To build the static site for deployment, run:
+
+  ~~~ 
+  mkdocs build
+  ~~~
+  
+The static site will be generated in the site/ directory.

docs/contacts.md

@@ -0,0 +1,18 @@
+# Contacts
+
+## Key Contacts
+
+### Operations Manager
+- **Name:** John Doe
+- **Email:** john.doe@example.com
+- **Phone:** (123) 456-7890
+
+### Technical Support
+- **Name:** Jane Smith
+- **Email:** jane.smith@example.com
+- **Phone:** (987) 654-3210
+
+### Maintenance Supervisor
+- **Name:** Bob Johnson
+- **Email:** bob.johnson@example.com
+- **Phone:** (555) 555-5555

docs/faq.md

@@ -0,0 +1,23 @@
+# Frequently Asked Questions (FAQ)
+
+## General
+
+### What is the capacity of our mining facility?
+- Our facility has 10 tanks containing varying numbers of Antminer S19s.
+
+### How do we monitor the mining operations?
+- We use Foreman (foreman.mn) to monitor all mining operations.
+
+### What communication tool do we use?
+- We use Slack for all team communications and alerts.
+
+## Technical
+
+### How often should we clean the miners?
+- Cleaning should be performed every three months or as needed based on environmental conditions.
+
+### What should I do if I get trapped in tank 5?
+- Call another technician to come let you out or derack a row of miners from the hot aisle and climb through to the cold aisle.
+
+### What should I do if a miner stops working?
+- Refer to the [Troubleshooting Operations](operations/troubleshooting.md) section for common issues and solutions.

docs/glossary.md

@@ -0,0 +1,18 @@
+# Glossary
+
+## Terms
+
+### ASIC Miner
+- **Definition:** Application-Specific Integrated Circuit miner, a device used for mining cryptocurrencies.
+
+### Foreman
+- **Definition:** A monitoring tool used to oversee and manage mining operations.
+
+### PSU
+- **Definition:** Power Supply Unit, provides power to the miners.
+
+### Slack
+- **Definition:** A communication platform used for team collaboration and alerts.
+
+### eeprom
+- **Definition:** Electrically erasable programmable read-only memory

docs/index.md

@@ -0,0 +1,19 @@
+# Welcome to the Megawatt Mining Manual
+
+This manual provides comprehensive documentation for setting up, operating, and maintaining your bitcoin mining facility.
+
+## Contents
+- [Setup](setup/)
+  - [Hardware](setup/hardware.md)
+  - [Software](setup/software.md)
+  - [Network](setup/network.md)
+- [Operations](operations/)
+  - [Monitoring](operations/monitoring.md)
+  - [Troubleshooting](operations/troubleshooting.md)
+- [Maintenance](maintenance/)
+  - [Cleaning](maintenance/cleaning.md)
+  - [Repairs](maintenance/repairs.md)
+- [FAQ](faq.md)
+- [Glossary](glossary.md)
+- [Contacts](contacts.md)
+- [Versioning](versioning.md)

docs/maintenance/cleaning.md

@@ -0,0 +1,15 @@
+# Cleaning Procedures
+
+## Cleaning Equipment
+- Compressed Air
+- Soft Brushes
+- Cleaning Cloths
+
+## Cleaning Steps
+1. **Power Down the Miner:** Ensure the miner is powered down and unplugged.
+2. **Remove Dust:** Use compressed air to blow out dust from the miner.
+3. **Clean Fans and Heat Sinks:** Use soft brushes and cleaning cloths to clean the fans and heat sinks.
+4. **Inspect for Damage:** Check for any visible damage or wear and tear.
+
+## Frequency
+- Perform cleaning every three months or as needed based on environmental conditions.

docs/maintenance/repairs.md

@@ -0,0 +1,26 @@
+# Repair Procedures
+
+## Common Repairs
+
+### Fan Replacements
+- **Steps:**
+  1. Power down the miner and unplug it.
+  2. Remove the faulty fan.
+  3. Install the new fan.
+  4. Power up the miner and verify operation.
+
+### Chip Swaps
+- **Steps:**
+  1. Power down the miner and unplug it.
+  2. Remove the damaged chip.
+  3. Install the new chip.
+  4. Power up the miner and verify operation.
+
+### Merges
+- **Steps:**
+  1. Power down the miner and unplug it.
+  2. Connect the miners as per the merge instructions.
+  3. Power up the miners and verify operation.
+
+## Repair Facility
+- All major repairs should be conducted at the primary facility designated for repairs.

docs/operations/monitoring.md

@@ -0,0 +1,9 @@
+# Monitoring Operations
+
+## Monitoring Tools
+- Foreman (foreman.mn)
+
+## Monitoring Steps
+1. **Set Up Foreman:** Ensure that all Antminer S19 units are registered and configured in Foreman.
+2. **Real-Time Monitoring:** Use Foreman to monitor real-time performance and status of each miner.
+3. **Alerts and Notifications:** Configure alerts in Foreman for any issues or irregularities. Use Slack for team notifications.

docs/operations/troubleshooting.md

@@ -0,0 +1,19 @@
+# Troubleshooting Operations
+
+## Common Issues and Solutions
+
+### Power Issues
+- **Symptom:** No power to the miner.
+- **Solution:** Check PSU connections and verify that the PSU is operational.
+
+### Network Issues
+- **Symptom:** Miner not connecting to the network.
+- **Solution:** Verify Ethernet cable connections, IP address assignment, and network settings.
+
+### Performance Issues
+- **Symptom:** Miner underperforming.
+- **Solution:** Check cooling systems, firmware updates, and miner configurations.
+
+### Foreman Alerts
+- **Symptom:** Alerts from Foreman.
+- **Solution:** Investigate the alert details in Foreman and take appropriate action.

docs/setup/hardware.md

@@ -0,0 +1,17 @@
+# Hardware Setup
+
+## Required Equipment
+- Antminer S19 (k pro, j pro xp, j models)
+- Power Supply Units (PSUs)
+- Ethernet Cables
+- Cooling Systems (fans, AC units)
+
+## Setup Steps
+1. **Unpack the Hardware:** Carefully remove the Antminer S19 units and PSUs from their packaging.
+2. **Connect Power Supplies:** Attach the PSU to each miner using the provided cables.
+3. **Network Configuration:** Connect the miners to your network using Ethernet cables.
+4. **Cooling Setup:** Ensure that all cooling systems are properly installed and functional.
+
+## Troubleshooting
+- **No Power:** Check the PSU connections and ensure that they are securely attached.
+- **Network Issues:** Verify that the Ethernet cables are properly connected and check your network settings.

docs/setup/network.md

@@ -0,0 +1,12 @@
+# Network Setup
+
+## Required Network Equipment
+- Routers
+- Switches
+- Ethernet Cables
+
+## Network Configuration Steps
+1. **Connect Routers and Switches:** Set up the network infrastructure by connecting routers and switches.
+2. **Assign IP Addresses:** Ensure that each Antminer S19 is assigned a unique IP address.
+3. **Configure Network Settings:** Set up the necessary network settings on each miner for optimal performance.
+4. **Monitor Network Activity:** Use Foreman to monitor network activity and miner performance.

docs/setup/software.md

@@ -0,0 +1,46 @@
+# Software Setup
+
+## Required Software
+- Foreman (foreman.mn) used for monitoring
+- Slack for communication
+- Firmware updates
+- IP reporting software
+
+## Installation Steps
+1. **Download Software:** Obtain the latest version of your preferred mining software.
+2. **Install Software:** Follow the installation instructions specific to your operating system.
+3. **Configure Software:** Edit the configuration files to include your mining pool information and other relevant settings.
+4. **Set Up Foreman:** Configure Foreman (foreman.mn) to monitor your mining activity.
+5. **Set Up Slack:** Integrate Slack for team communication and alerts.
+
+## Firmware used
+- Stock Bitmain firmware
+- Braiins OS
+- LuxOS
+
+## LuxOS Settings:
+
+#### NOTE: USER MUST ENTER VALUES IN BLANK FIELDS
+
+- **Power:**
+    - power mode: active
+    - autotuner: enabled. 
+    - Profile tab empty
+- **General settings:**
+    - minimum fan: 4
+    - overtemp: enabled
+    - NoPIC: enabled
+- **ATM:**
+    - ATM:ON
+    - Hot Board Buffer: 5
+    - min profile -4 steps
+    - Max profile: default
+    - Startup time: 1 
+    - post ramping time: 1
+- **Pool Configuration:**
+    - No changes made here
+- **Firmware:**
+    - Update Firmware: stable
+
+### To add:
+Information on firmware settings, tuning, etc

docs/versioning.md

@@ -0,0 +1,14 @@
+# Versioning
+
+## Version Control
+
+### Current Version
+- **Version:** 0.1
+- **Release Date:** June 20, 2024
+
+### Version History
+
+#### Version 0.1
+- **Release Date:** June 20, 2024
+- **Changes:**
+  - Initial alpha foundation build with setup, operations, maintenance, FAQ, and contacts sections.

mkdocs.yml

@@ -0,0 +1,20 @@
+site_name: Megawatt Mining Manual
+nav:
+  - Home: index.md
+  - Setup:
+      - Hardware: setup/hardware.md
+      - Software: setup/software.md
+      - Network: setup/network.md
+  - Operations:
+      - Monitoring: operations/monitoring.md
+      - Troubleshooting: operations/troubleshooting.md
+  - Maintenance:
+      - Cleaning: maintenance/cleaning.md
+      - Repairs: maintenance/repairs.md
+  - FAQ: faq.md
+  - Glossary: glossary.md
+  - Contacts: contacts.md
+  - Versioning: versioning.md
+theme:
+  name: readthedocs
+  search: true