Retropex/custom-ocean.xyz-dashboard
1
0
Fork 0
mirror of https://github.com/Retropex/custom-ocean.xyz-dashboard.git synced 2025-05-12 19:20:45 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Enhance README.md with new features and guidance

Browse Source 
Updated README.md to include:
- Multi-Currency Support with configuration options and notifications
- Expanded Worker Management section with new API endpoints
- Added preferred fiat currency to environment variables in `docker-compose.yml`
- New API endpoints for managing notifications and fetching exchange rates
- Additional user guidance for currency and timezone settings
This commit is contained in:
DJObleezy 2025-04-27 17:10:11 -07:00
parent 923a4826a9
commit b92f8074da
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -28,6 +28,13 @@ This open-source dashboard provides real-time monitoring for Ocean.xyz pool mine
- **Payout Monitoring**: View unpaid balance and estimated time to next payout - **Payout Monitoring**: View unpaid balance and estimated time to next payout
- **Pool Fee Analysis**: Monitor pool fee percentages with visual indicator when optimal rates (0.9-1.3%) are detected - **Pool Fee Analysis**: Monitor pool fee percentages with visual indicator when optimal rates (0.9-1.3%) are detected
### Multi-Currency Support
- **Flexible Currency Configuration: Set your preferred fiat currency for displaying Bitcoin value and earnings
- **Wide Currency Selection: Choose from USD, EUR, GBP, JPY, CAD, AUD, CNY, KRW, BRL, CHF and more
- **Real-Time Exchange Rates: Automatically fetches up-to-date exchange rates from public APIs
- **Persistent Configuration: Currency preferences saved and restored between sessions
- **Adaptive Notifications: Financial notifications display in your selected currency
### Worker Management ### Worker Management
- **Fleet Overview**: Comprehensive view of all mining devices in one interface - **Fleet Overview**: Comprehensive view of all mining devices in one interface
- **Status Monitoring**: Real-time status indicators for online and offline devices - **Status Monitoring**: Real-time status indicators for online and offline devices
@ -114,6 +121,7 @@ You can modify the following environment variables in the `docker-compose.yml` f
- `POWER_USAGE`: Power usage in watts. - `POWER_USAGE`: Power usage in watts.
- `NETWORK_FEE`: Additional fees beyond pool fees (e.g., firmware fees). - `NETWORK_FEE`: Additional fees beyond pool fees (e.g., firmware fees).
- `TIMEZONE`: Local timezone for displaying time information. - `TIMEZONE`: Local timezone for displaying time information.
- `CURRENCY`: Preferred fiat currency for earnings display.
Redis data is stored in a persistent volume (`redis_data`), and application logs are saved in the `./logs` directory. Redis data is stored in a persistent volume (`redis_data`), and application logs are saved in the `./logs` directory.
@ -174,6 +182,9 @@ Built with a modern stack for reliability and performance:
- `/api/available_timezones`: Returns a list of supported timezones. - `/api/available_timezones`: Returns a list of supported timezones.
- `/api/config`: Fetches or updates the mining configuration. - `/api/config`: Fetches or updates the mining configuration.
- `/api/health`: Returns the health status of the application. - `/api/health`: Returns the health status of the application.
- `/api/notifications`: Manages notifications for the user.
- `/api/workers`: Manages worker data and status.
- `/api/exchange_rates`: Fetches real-time exchange rates for supported currencies.
## Project Structure ## Project Structure
@ -244,6 +255,9 @@ For optimal performance:
4. Access the health endpoint at `/api/health` for diagnostics 4. Access the health endpoint at `/api/health` for diagnostics
5. For stale data issues, use the Force Refresh function 5. For stale data issues, use the Force Refresh function
6. Use hotkey Shift+R to clear chart and Redis data (as needed, not required) 6. Use hotkey Shift+R to clear chart and Redis data (as needed, not required)
7. Check the currency settings if financial calculations appear incorrect
8. Verify timezone settings for accurate time displays
9. Alt + W on Dashboard resets wallet configuration and redirects to Boot sequence
## License ## License