Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ryvn.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Servers are HTTP/HTTPS services that handle web traffic and serve content to users. They’re ideal for web applications (Next.js, React), APIs (FastAPI, Go), and any service that needs to respond to HTTP requests. Each server runs in a containerized environment with automatic load balancing, health monitoring, and zero-downtime deployments.
Your application must bind to host 0.0.0.0 to receive HTTP traffic. Binding to localhost or 127.0.0.1 will prevent the service from receiving external requests.

​
Installation configuration

When you deploy a service to an environment, it creates an installation. An installation is a running instance of your service with its own configuration, resources, and scaling settings. For example, you might have:
  • A production installation with high availability and strict security in a customer’s cloud
  • A production multi-tenant installation in your cloud serving multiple customers
  • A development installation with minimal resources for testing in your cloud

​
Networking mode

Every server needs a networking mode that determines its accessibility and security boundaries. Choose the right mode based on your service’s requirements and security needs:

Public

Exposes your service to the internet with automatic SSL/TLS certificates and DDoS protection. Perfect for customer-facing applications and APIs running in your cloud or customer clouds.
  • Custom domain support
  • Automatic certificate management

Internal

Accessible within your Ryvn environment and connected networks. Ideal for microservices that need to communicate with other services while integrating with customer infrastructure.
  • Access from connected networks
  • Cross-environment communication

Private

Only accessible within the same Ryvn environment. Essential for sensitive operations like database proxies and credential managers that require complete isolation.
  • Same-environment access only
  • Maximum security isolation

​
Port configuration

Specify which port your application listens on. While any available port can be used, we recommend following standard conventions (e.g., 3000 for Node.js, 8080 for Java, 80 for nginx).

​
Environment variables

Define environment-specific configuration and secrets. See our guide on environment variables for secure configuration management and best practices.

​
Health checks

Configure health monitoring to ensure zero-downtime deployments. Health checks verify critical dependencies and help Ryvn manage traffic routing and container lifecycle. Learn more about health check configuration.

​
Auto-scaling

Set up dynamic scaling based on traffic patterns and resource utilization. Ryvn automatically adjusts the number of instances based on your configured metrics. Read about scaling configuration and monitor through metrics.

​
Resource management

Define compute resources for predictable performance. Set appropriate CPU and memory limits to ensure consistent performance. Understanding Kubernetes basics can help with optimal resource configuration.

​
Release management

Control deployment rollouts using release channels with automated and manual controls. Configure promotion policies, approvals, and automatic rollbacks. Learn more about release channels, rollbacks, and maintenance windows.