Creating Service Instances
This guide shows you how to create new service instances in the Vidos platform. You'll learn how to set up instances with appropriate configurations for your specific use cases and environments.
Prerequisites
Before you begin, ensure you have:
Understanding Service Instances
Service instances are independent, configurable units of Vidos services that you can customize for specific use cases, environments, or applications. Each instance can have its own configuration, policies, and operational state.
Applicable Services
The Vidos platform provides these core services for instance creation:
- Authorizer: Orchestrates OpenID4VP authorization workflows
- Gateway: Provides unified entry point for accessing Vidos services
- Resolver: Translates DIDs into DID documents for verification
- Validator: Ensures data conforms to expected schemas and formats
- Verifier: Evaluates cryptographic proofs and credentials
Creating a New Instance
Follow these steps to create a service instance tailored to your requirements.
Steps to Create an Instance
- Navigate to the appropriate service section in your Vidos dashboard (Resolvers, Verifiers, Validators, etc.)
- Click the Add button to create a new instance
- Provide a unique ID for your instance (must be unique within the service/region)
- Optionally provide a label for your instance that indicates its purpose and environment
- Configure the instance settings according to your requirements
- Click Save to create the instance
Instance Naming Best Practices
When creating instances, you'll need to provide a unique ID and can optionally provide a descriptive name:
Instance ID Requirements:
- Must be unique within the service and region
- Use lowercase letters, numbers, and hyphens only
- Keep it short and memorable (e.g., "prod-web", "test-api", "dev-mobile")
Label:
The label is an optional label that can help you identify the instance's purpose:
Use clear, descriptive names that indicate the instance's purpose and environment:
Environment-based Naming:
- "Production-WebApp-Resolver"
- "Testing-API-Verifier"
- "Development-Mobile-Gateway"
Use-case-based Naming:
- "JWT-Credential-Validator"
- "DID-Document-Resolver"
- "OAuth-Authorization-Service"
Application-based Naming:
- "Mobile-App-Authorizer"
- "Dashboard-Gateway"
- "API-Integration-Verifier"
TIP
Create separate service instances for different environments (development, testing, production) to maintain clear separation of concerns and prevent configuration changes in one environment from affecting others.
Next steps