mirror of
https://github.com/Retropex/custom-ocean.xyz-dashboard.git
synced 2025-05-12 19:20:45 +02:00
Update README.md
This commit is contained in:
parent
3f867264ac
commit
cee6eec403
32
README.md
32
README.md
@ -53,8 +53,8 @@ This open-source dashboard provides real-time monitoring for Ocean.xyz pool mine
|
|||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository
|
||||||
```
|
```
|
||||||
git clone [https://github.com/Djobleezy/Custom-Ocean.xyz-Dashboard.git](https://github.com/Djobleezy/Custom-Ocean.xyz-Dashboard.git)
|
git clone https://github.com/yourusername/bitcoin-mining-dashboard.git
|
||||||
cd custom-ocean.xyz-dashboard
|
cd bitcoin-mining-dashboard
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
@ -96,6 +96,34 @@ docker run -d -p 5000:5000 \
|
|||||||
|
|
||||||
For detailed deployment instructions with Redis persistence and Gunicorn configuration, see [deployment_steps.md](deployment_steps.md).
|
For detailed deployment instructions with Redis persistence and Gunicorn configuration, see [deployment_steps.md](deployment_steps.md).
|
||||||
|
|
||||||
|
## Using docker-compose
|
||||||
|
|
||||||
|
The `docker-compose.yml` file makes it easy to deploy the dashboard and its dependencies.
|
||||||
|
|
||||||
|
### Steps to Deploy
|
||||||
|
|
||||||
|
1. **Start the services**:
|
||||||
|
Run the following command in the project root:
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
2. **Access the dashboard**:
|
||||||
|
Open your browser at `http://localhost:5000`.
|
||||||
|
|
||||||
|
3. **Stop the services**:
|
||||||
|
To stop the services, run:
|
||||||
|
docker-compose down
|
||||||
|
|
||||||
|
### Customization
|
||||||
|
|
||||||
|
You can modify the following environment variables in the `docker-compose.yml` file:
|
||||||
|
- `WALLET`: Your Bitcoin wallet address.
|
||||||
|
- `POWER_COST`: Cost of power per kWh.
|
||||||
|
- `POWER_USAGE`: Power usage in watts.
|
||||||
|
|
||||||
|
Redis data is stored in a persistent volume (`redis_data`), and application logs are saved in the `./logs` directory.
|
||||||
|
|
||||||
|
For more details, refer to the [docker-compose documentation](https://docs.docker.com/compose/).
|
||||||
|
|
||||||
## Dashboard Components
|
## Dashboard Components
|
||||||
|
|
||||||
### Main Dashboard
|
### Main Dashboard
|
||||||
|
Loading…
Reference in New Issue
Block a user