laantungir/routstr-core

Fork 0

mirror of https://github.com/Routstr/routstr-core.git synced 2026-08-09 11:04:36 +00:00

Files

T

Shroominic f1d4dd6ff4 edits

2025-08-25 01:56:09 -03:00

6.6 KiB

Raw Blame History

Admin Dashboard

The Routstr admin dashboard provides a web interface for managing your node, viewing balances, and handling withdrawals.

Accessing the Dashboard

URL Format

The admin dashboard is available at:

https://api.routstr.com/admin/

Important

: Always include the trailing slash (/) in the URL.

Authentication

The dashboard is protected by a password set in the ADMIN_PASSWORD environment variable.

Navigate to /admin/
Enter the admin password
Click "Login"

The password is stored as a secure cookie for the session.

Dashboard Overview

Main Interface

The dashboard displays:

Node Information
- Node name and description
- Version number
- Public URLs (HTTP and Onion)
- Supported Cashu mints
Statistics
- Total API keys
- Active keys
- Total balance across all keys
- Recent activity
API Key List
- All keys with balances
- Usage statistics
- Management options

Features

Viewing API Keys

The main table shows all API keys with:

Column	Description
API Key	Masked key (first/last 4 chars)
Balance	Current balance in sats
Created	Creation timestamp
Last Used	Most recent API call
Total Spent	Lifetime usage
Status	Active/Expired/Disabled

Searching and Filtering

Search: Find keys by partial match
Sort: Click column headers to sort
Filter: Show only active/expired keys
Export: Download data as CSV

Key Details

Click on any key to view:

Full API key (masked by default)
Complete transaction history
Usage graphs
Metadata (name, expiry, refund address)

Balance Management

Viewing Balances

Balances are displayed in multiple units:

Sats: Standard satoshi units
mSats: Millisatoshis (internal precision)
BTC: Bitcoin decimal format
USD: Approximate USD value

Balance History

View balance changes over time:

Time         | Type      | Amount  | Balance | Description
-------------|-----------|---------|---------|-------------
12:34:56     | Deposit   | +10,000 | 10,000  | Token redemption
12:35:12     | Usage     | -154    | 9,846   | gpt-3.5-turbo call
12:36:45     | Usage     | -210    | 9,636   | gpt-4 call

Withdrawals

Manual Withdrawal

To withdraw funds from an API key:

Click "Withdraw" next to the key
Optionally specify amount (default: full balance)
Select target Cashu mint
Click "Generate Token"
Copy the eCash token
Redeem in your Cashu wallet

Bulk Operations

For multiple withdrawals:

Select keys using checkboxes
Click "Bulk Actions" → "Withdraw"
Tokens are generated for each key
Download all tokens as text file

Automatic Withdrawals

If configured with RECEIVE_LN_ADDRESS:

Balances above threshold auto-convert to Lightning
Sent to configured Lightning address
View payout history in dashboard

Node Configuration

Viewing Settings

Current node configuration is displayed:

Upstream provider URL
Enabled features
Pricing model
Fee structure

Models and Pricing

View supported models and their pricing:

Model	Input $/1K	Output $/1K	Sats/1K
gpt-3.5-turbo	$0.0015	$0.002	3/4
gpt-4	$0.03	$0.06	60/120
dall-e-3	-	-	1000/image

Updating Configuration

Note

: Configuration changes require node restart.

To update settings:

Modify environment variables
Restart the node
Verify changes in dashboard

Analytics

Usage Statistics

View comprehensive usage data:

Requests per Day: Line graph
Token Usage: Stacked bar chart
Model Distribution: Pie chart
Cost Analysis: Breakdown by model

Performance Metrics

Monitor node performance:

Average response time
Request success rate
Upstream API latency
Cache hit ratio

Export Data

Export analytics data:

Select date range
Choose metrics
Click "Export"
Download as CSV/JSON

Security Features

Access Control

Password protection
Session timeout (configurable)
IP allowlisting (optional)
Audit logging

Security Log

View security events:

2024-01-15 12:34:56 | Login Success | IP: 192.168.1.1
2024-01-15 12:35:12 | Withdrawal | Key: sk-****abcd | Amount: 5000
2024-01-15 12:40:00 | Session Timeout | IP: 192.168.1.1

Best Practices

Strong Password: Use a long, random password
HTTPS Only: Always access via HTTPS
Regular Monitoring: Check logs frequently
Limited Access: Restrict dashboard access

Troubleshooting

Cannot Access Dashboard

Issue: 404 Not Found

Ensure trailing slash: /admin/
Check if admin routes are enabled

Issue: Unauthorized

Verify ADMIN_PASSWORD is set
Clear browser cookies
Try incognito/private mode

Display Issues

Issue: Broken Layout

Clear browser cache
Disable ad blockers
Try different browser

Issue: Missing Data

Check database connectivity
Verify node is running
Review error logs

Withdrawal Problems

Issue: Token Generation Fails

Check mint connectivity
Verify sufficient balance
Try different mint

Issue: Invalid Token

Ensure complete token copy
Check token hasn't expired
Verify mint compatibility

Advanced Features

Custom Branding

Customize dashboard appearance:

# Environment variables
ADMIN_LOGO_URL=https://example.com/logo.png
ADMIN_THEME_COLOR=#FF6B00
ADMIN_CUSTOM_CSS=/path/to/custom.css

API Access

Access admin functions programmatically:

# Get node stats
curl -X GET https://your-node.com/admin/api/stats \
  -H "X-Admin-Password: your-password"

# Export key data
curl -X GET https://your-node.com/admin/api/keys \
  -H "X-Admin-Password: your-password" \
  -H "Accept: application/json"

Webhooks

Configure notifications:

ADMIN_WEBHOOK_URL=https://example.com/webhook
ADMIN_WEBHOOK_EVENTS=withdrawal,low_balance,error

Dashboard Shortcuts

Ctrl+K: Quick search
Ctrl+R: Refresh data
Ctrl+E: Export current view
Escape: Close modals

Quick Actions

Double-click to copy API key
Right-click for context menu
Drag to reorder columns
Shift-click to select multiple

Mobile Access

The dashboard is mobile-responsive:

Touch-optimized controls
Swipe navigation
Compact view mode
Offline capability

Next Steps

Models & Pricing - Configure pricing
API Reference - Admin API endpoints
Advanced Configuration - Advanced settings

6.6 KiB Raw Blame History