Loading Documentation Hub...
Scanning documentation library
Loading Documentation Hub...
Scanning documentation library
Documentation
📚 Documentation
Loading Documentation Hub...
Scanning documentation library
Scanning documentation library
Scanning documentation library
Scanning documentation library
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
The Ring CLI is a powerful command-line interface that streamlines deployment, configuration, and management of Ring Platform applications. With simple commands, you can deploy to production, manage configurations, and monitor your platform's health.
Install the Ring CLI globally from your Ring Platform directory:
Navigate to your Ring Platform directory Install globally using npm link Verify installation Output: 1.0.1
Deploy to production with a single command:
Deploy using version from package.json Deploy specific version Preview without executing
This creates a global symlink to your local Ring Platform installation, perfect for development.
Remove global link Or from any directory
ring prod - Production DeploymentDeploy your Ring Platform to production Kubernetes cluster with automated Docker building, pushing, and deployment.
The Ring CLI is a powerful command-line interface that streamlines deployment, configuration, and management of Ring Platform applications. With simple commands, you can deploy to production, manage configurations, and monitor your platform's health.
Install the Ring CLI globally from your Ring Platform directory:
Navigate to your Ring Platform directory Install globally using npm link Verify installation Output: 1.0.1
Deploy to production with a single command:
Deploy using version from package.json Deploy specific version Preview without executing
This creates a global symlink to your local Ring Platform installation, perfect for development.
Remove global link Or from any directory
ring prod - Production DeploymentDeploy your Ring Platform to production Kubernetes cluster with automated Docker building, pushing, and deployment.
The Ring CLI is a powerful command-line interface that streamlines deployment, configuration, and management of Ring Platform applications. With simple commands, you can deploy to production, manage configurations, and monitor your platform's health.
Install the Ring CLI globally from your Ring Platform directory:
Navigate to your Ring Platform directory Install globally using npm link Verify installation Output: 1.0.1
Deploy to production with a single command:
Deploy using version from package.json Deploy specific version Preview without executing
This creates a global symlink to your local Ring Platform installation, perfect for development.
Remove global link Or from any directory
ring prod - Production DeploymentDeploy your Ring Platform to production Kubernetes cluster with automated Docker building, pushing, and deployment.
Deploy with auto-detected version Deploy specific version Skip certain steps Preview commands without execution
package.json or --version flagghcr.io/connectplatform/ringThe CLI automatically includes these build arguments from your configuration:
Deploy with auto-detected version Deploy specific version Skip certain steps Preview commands without execution
package.json or --version flagghcr.io/connectplatform/ringThe CLI automatically includes these build arguments from your configuration:
Deploy with auto-detected version Deploy specific version Skip certain steps Preview commands without execution
package.json or --version flagghcr.io/connectplatform/ringThe CLI automatically includes these build arguments from your configuration:
AUTH_SECRET - Auth.js secret for JWT signingAUTH_GOOGLE_ID - Google OAuth client IDAUTH_GOOGLE_SECRET - Google OAuth client secretAUTH_APPLE_ID - Apple Sign-in service IDAUTH_APPLE_SECRET - Apple Sign-in JWT secretAUTH_FIREBASE_PROJECT_ID - Firebase project identifierAUTH_FIREBASE_CLIENT_EMAIL - Firebase service account emailAUTH_FIREBASE_PRIVATE_KEY - Firebase private keyWALLET_ENCRYPTION_KEY - Web3 wallet encryptionPOLYGON_RPC_URL - Polygon network RPC endpointDB_HOST, DB_PORT, DB_NAME, DB_USER, DB_PASSWORD - Database configurationNEXT_PUBLIC_APP_URL - Public application URLNEXT_PUBLIC_API_URL - Public API URLAUTH_SECRET - Auth.js secret for JWT signingAUTH_GOOGLE_ID - Google OAuth client IDAUTH_GOOGLE_SECRET - Google OAuth client secretAUTH_APPLE_ID - Apple Sign-in service IDAUTH_APPLE_SECRET - Apple Sign-in JWT secretAUTH_FIREBASE_PROJECT_ID - Firebase project identifierAUTH_FIREBASE_CLIENT_EMAIL - Firebase service account emailAUTH_FIREBASE_PRIVATE_KEY - Firebase private keyWALLET_ENCRYPTION_KEY - Web3 wallet encryptionPOLYGON_RPC_URL - Polygon network RPC endpointDB_HOST, DB_PORT, DB_NAME, DB_USER, DB_PASSWORD - Database configurationNEXT_PUBLIC_APP_URL - Public application URLNEXT_PUBLIC_API_URL - Public API URLAUTH_SECRET - Auth.js secret for JWT signingAUTH_GOOGLE_ID - Google OAuth client IDAUTH_GOOGLE_SECRET - Google OAuth client secretAUTH_APPLE_ID - Apple Sign-in service IDAUTH_APPLE_SECRET - Apple Sign-in JWT secretAUTH_FIREBASE_PROJECT_ID - Firebase project identifierAUTH_FIREBASE_CLIENT_EMAIL - Firebase service account emailAUTH_FIREBASE_PRIVATE_KEY - Firebase private keyWALLET_ENCRYPTION_KEY - Web3 wallet encryptionPOLYGON_RPC_URL - Polygon network RPC endpointDB_HOST, DB_PORT, DB_NAME, DB_USER, DB_PASSWORD - Database configurationNEXT_PUBLIC_APP_URL - Public application URLNEXT_PUBLIC_API_URL - Public API URLring config - Configuration ManagementManage global CLI configuration stored in ~/.ring-platform/config.json.
Set individual values Set nested values
Get specific value Output: postgresql List all configuration Example output:
Reset to defaults ✅ Configuration reset to defaults
ring status - Deployment StatusCheck the health and status of your Ring Platform deployment.
Basic status check Detailed output Check different namespace
/api/health endpoint check🔍 Checking Ring Platform Status...
✅ Kubernetes Pods
ring-platform-7c5c6fc797-abc123: Running (0 restarts)
ring-platform-7c5c6fc797-def456: Running (0 restarts)
✅ Services
ring-platform-service: LoadBalancer (10.10.0.41)
✅ Ingress
ring-platform-ingress: Active (SSL: Valid)
✅ Application Health
https://ring-platform.org/api/health: 200 OK
✅ Database
PostgreSQL: Connected (15 active connections)
🎉 All systems operational!
ring config - Configuration ManagementManage global CLI configuration stored in ~/.ring-platform/config.json.
Set individual values Set nested values
Get specific value Output: postgresql List all configuration Example output:
Reset to defaults ✅ Configuration reset to defaults
ring status - Deployment StatusCheck the health and status of your Ring Platform deployment.
Basic status check Detailed output Check different namespace
/api/health endpoint check🔍 Checking Ring Platform Status...
✅ Kubernetes Pods
ring-platform-7c5c6fc797-abc123: Running (0 restarts)
ring-platform-7c5c6fc797-def456: Running (0 restarts)
✅ Services
ring-platform-service: LoadBalancer (10.10.0.41)
✅ Ingress
ring-platform-ingress: Active (SSL: Valid)
✅ Application Health
https://ring-platform.org/api/health: 200 OK
✅ Database
PostgreSQL: Connected (15 active connections)
🎉 All systems operational!
ring config - Configuration ManagementManage global CLI configuration stored in ~/.ring-platform/config.json.
Set individual values Set nested values
Get specific value Output: postgresql List all configuration Example output:
Reset to defaults ✅ Configuration reset to defaults
ring status - Deployment StatusCheck the health and status of your Ring Platform deployment.
Basic status check Detailed output Check different namespace
/api/health endpoint check🔍 Checking Ring Platform Status...
✅ Kubernetes Pods
ring-platform-7c5c6fc797-abc123: Running (0 restarts)
ring-platform-7c5c6fc797-def456: Running (0 restarts)
✅ Services
ring-platform-service: LoadBalancer (10.10.0.41)
✅ Ingress
ring-platform-ingress: Active (SSL: Valid)
✅ Application Health
https://ring-platform.org/api/health: 200 OK
✅ Database
PostgreSQL: Connected (15 active connections)
🎉 All systems operational!
ring test - Database and Service TestingRun comprehensive tests for database connections, services, and data integrity.
Test PostgreSQL database connection Test DatabaseService initialization Test user data retrieval Test username query functionality
db-connection - Tests PostgreSQL connectivity and basic database health:
db-service - Tests DatabaseService initialization and operations:
user-data - Tests user data retrieval and structure validation:
username - Tests username query functionality and data structure:
🧪 Running Ring Platform tests...
Testing PostgreSQL connection...
✅ PostgreSQL connection successful!
Users table exists: ✅
User count: 1
✅ Test completed successfully!
ring test - Database and Service TestingRun comprehensive tests for database connections, services, and data integrity.
Test PostgreSQL database connection Test DatabaseService initialization Test user data retrieval Test username query functionality
db-connection - Tests PostgreSQL connectivity and basic database health:
db-service - Tests DatabaseService initialization and operations:
user-data - Tests user data retrieval and structure validation:
username - Tests username query functionality and data structure:
🧪 Running Ring Platform tests...
Testing PostgreSQL connection...
✅ PostgreSQL connection successful!
Users table exists: ✅
User count: 1
✅ Test completed successfully!
ring test - Database and Service TestingRun comprehensive tests for database connections, services, and data integrity.
Test PostgreSQL database connection Test DatabaseService initialization Test user data retrieval Test username query functionality
db-connection - Tests PostgreSQL connectivity and basic database health:
db-service - Tests DatabaseService initialization and operations:
user-data - Tests user data retrieval and structure validation:
username - Tests username query functionality and data structure:
🧪 Running Ring Platform tests...
Testing PostgreSQL connection...
✅ PostgreSQL connection successful!
Users table exists: ✅
User count: 1
✅ Test completed successfully!
The Ring CLI stores configuration in ~/.ring-platform/config.json:
The CLI respects these environment variables:
RING_K8S_CONTROL_NODE - Override Kubernetes control nodeRING_K8S_NAMESPACE - Override namespaceRING_REGISTRY - Override container registryRING_DATABASE_TYPE - Override database typeDeploy to staging Test staging Promote to production
Deploy previous version Or use kubectl directly
The Ring CLI stores configuration in ~/.ring-platform/config.json:
The CLI respects these environment variables:
RING_K8S_CONTROL_NODE - Override Kubernetes control nodeRING_K8S_NAMESPACE - Override namespaceRING_REGISTRY - Override container registryRING_DATABASE_TYPE - Override database typeDeploy to staging Test staging Promote to production
Deploy previous version Or use kubectl directly
The Ring CLI stores configuration in ~/.ring-platform/config.json:
The CLI respects these environment variables:
RING_K8S_CONTROL_NODE - Override Kubernetes control nodeRING_K8S_NAMESPACE - Override namespaceRING_REGISTRY - Override container registryRING_DATABASE_TYPE - Override database typeDeploy to staging Test staging Promote to production
Deploy previous version Or use kubectl directly
on:
push:
tags:
- 'v*'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
on:
push:
tags:
- 'v*'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
on:
push:
tags:
- 'v*'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
sh 'npm link'
sh 'ring config --set k8s.controlNode=${K8S_HOST}'
sh 'ring prod --version ${BUILD_NUMBER}'
}
}
stage('Verify') {
steps {
sh 'ring status --verbose'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
sh 'npm link'
sh 'ring config --set k8s.controlNode=${K8S_HOST}'
sh 'ring prod --version ${BUILD_NUMBER}'
}
}
stage('Verify') {
steps {
sh 'ring status --verbose'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
sh 'npm link'
sh 'ring config --set k8s.controlNode=${K8S_HOST}'
sh 'ring prod --version ${BUILD_NUMBER}'
}
}
stage('Verify') {
steps {
sh 'ring status --verbose'
Error: command not found: ring Solution 1: Install globally Solution 2: Use npx
Error: ssh: connect to host k8s-control-01 port 22: Connection refused Solution: Configure SSH
Error: Cannot connect to the Docker daemon Solution: Ensure Docker is running
Error: EACCES: permission denied Solution: Fix npm permissions Or use a Node version manager like nvm
Enable debug output for troubleshooting:
Set debug environment variable Verbose logging Dry run to see commands
Always tag your releases:
Sensitive values in configuration are masked:
Shows: "auth.secret": "********************************"
Always verify after deployment:
Error: command not found: ring Solution 1: Install globally Solution 2: Use npx
Error: ssh: connect to host k8s-control-01 port 22: Connection refused Solution: Configure SSH
Error: Cannot connect to the Docker daemon Solution: Ensure Docker is running
Error: EACCES: permission denied Solution: Fix npm permissions Or use a Node version manager like nvm
Enable debug output for troubleshooting:
Set debug environment variable Verbose logging Dry run to see commands
Always tag your releases:
Sensitive values in configuration are masked:
Shows: "auth.secret": "********************************"
Always verify after deployment:
Error: command not found: ring Solution 1: Install globally Solution 2: Use npx
Error: ssh: connect to host k8s-control-01 port 22: Connection refused Solution: Configure SSH
Error: Cannot connect to the Docker daemon Solution: Ensure Docker is running
Error: EACCES: permission denied Solution: Fix npm permissions Or use a Node version manager like nvm
Enable debug output for troubleshooting:
Set debug environment variable Verbose logging Dry run to see commands
Always tag your releases:
Sensitive values in configuration are masked:
Shows: "auth.secret": "********************************"
Always verify after deployment:
Backup your CLI configuration:
Planned enhancements for Ring CLI:
Backup your CLI configuration:
Planned enhancements for Ring CLI:
Backup your CLI configuration:
Planned enhancements for Ring CLI:
ring init - Initialize new Ring Platform projectring dev - Start local development environmentring migrate - Database migration managementring backup - Backup database and configurationsring logs - Stream application logsring scale - Scale deployment replicasring rollback - Rollback to previous versionring env - Environment variable managementring secrets - Kubernetes secrets managementring init - Initialize new Ring Platform projectring dev - Start local development environmentring migrate - Database migration managementring backup - Backup database and configurationsring logs - Stream application logsring scale - Scale deployment replicasring rollback - Rollback to previous versionring env - Environment variable managementring secrets - Kubernetes secrets managementring init - Initialize new Ring Platform projectring dev - Start local development environmentring migrate - Database migration managementring backup - Backup database and configurationsring logs - Stream application logsring scale - Scale deployment replicasring rollback - Rollback to previous versionring env - Environment variable managementring secrets - Kubernetes secrets managementThe Ring CLI is continuously evolving. Check for updates with ring --version and update with git pull && npm link.
The Ring CLI is continuously evolving. Check for updates with ring --version and update with git pull && npm link.
The Ring CLI is continuously evolving. Check for updates with ring --version and update with git pull && npm link.