README
¶
Orris
Quick Install
curl -fsSL https://raw.githubusercontent.com/orris-inc/orris/main/install.sh | bash
Or specify domain and admin credentials:
curl -fsSL https://raw.githubusercontent.com/orris-inc/orris/main/install.sh | \
DOMAIN=orris.example.com \
ADMIN_EMAIL=admin@example.com \
ADMIN_PASSWORD=your-password \
bash
Detailed Installation
See INSTALL.md for detailed installation instructions.
Update
Update to the latest version:
# From your Orris installation directory
./install.sh update
# Or remotely
curl -fsSL https://raw.githubusercontent.com/orris-inc/orris/main/install.sh | bash -s -- update
This will:
- Pull the latest Docker images
- Run database migrations
- Restart all services
Common Commands
docker compose ps # Check status
docker compose logs -f # View logs
docker compose down # Stop services
docker compose up -d # Start services
./install.sh update # Update to latest version
./install.sh help # Show help
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
orris
command
|
|
|
internal
|
|
|
application/admin/usecases/trafficstatsutil
Package trafficstatsutil provides shared utilities for traffic statistics use cases.
|
Package trafficstatsutil provides shared utilities for traffic statistics use cases. |
|
application/common/dto
Package dto provides common data transfer objects shared across domains.
|
Package dto provides common data transfer objects shared across domains. |
|
application/forward/dto
Package dto provides data transfer objects for the forward domain.
|
Package dto provides data transfer objects for the forward domain. |
|
application/forward/services
Package services provides application services for the forward domain.
|
Package services provides application services for the forward domain. |
|
application/forward/testutil
Package testutil provides mock implementations for testing the forward application layer.
|
Package testutil provides mock implementations for testing the forward application layer. |
|
application/forward/usecases
Package usecases provides application layer use cases for forward operations.
|
Package usecases provides application layer use cases for forward operations. |
|
application/node/dto
Package dto provides data transfer objects for the node domain.
|
Package dto provides data transfer objects for the node domain. |
|
application/node/services
Package services provides application-level services for the node domain.
|
Package services provides application-level services for the node domain. |
|
application/subscription/usecases
Package usecases provides application-level use cases for subscription management.
|
Package usecases provides application-level use cases for subscription management. |
|
domain/forward
Package forward provides domain models and business logic for forward agent management.
|
Package forward provides domain models and business logic for forward agent management. |
|
domain/forward/testutil
Package testutil provides testing utilities and fixtures for the forward domain.
|
Package testutil provides testing utilities and fixtures for the forward domain. |
|
domain/forward/valueobjects
Package valueobjects provides value objects for the forward domain.
|
Package valueobjects provides value objects for the forward domain. |
|
domain/node
Package node provides domain models and business logic for node management.
|
Package node provides domain models and business logic for node management. |
|
domain/resource
Package resource provides domain models for resource management.
|
Package resource provides domain models for resource management. |
|
domain/shared
Package shared provides reusable domain logic shared across aggregates.
|
Package shared provides reusable domain logic shared across aggregates. |
|
domain/subscription
Package subscription provides domain models and business logic for subscription management.
|
Package subscription provides domain models and business logic for subscription management. |
|
domain/user
Package user provides domain models and business logic for user management.
|
Package user provides domain models and business logic for user management. |
|
infrastructure/persistence/nodeutil
Package nodeutil provides utilities for building subscription nodes.
|
Package nodeutil provides utilities for building subscription nodes. |
|
infrastructure/scheduler
Package scheduler provides unified scheduler management using gocron v2.
|
Package scheduler provides unified scheduler management using gocron v2. |
|
infrastructure/services
Package services provides infrastructure services.
|
Package services provides infrastructure services. |
|
infrastructure/services/forwarder
Package forwarder provides TCP/UDP port forwarding functionality.
|
Package forwarder provides TCP/UDP port forwarding functionality. |
|
infrastructure/services/protocol
Package protocol provides protocol detection and sniffing functionality.
|
Package protocol provides protocol detection and sniffing functionality. |
|
interfaces/adapters
Package adapters provides infrastructure adapters.
|
Package adapters provides infrastructure adapters. |
|
interfaces/adapters/cacheutil
Package cacheutil provides common cache utilities for infrastructure adapters.
|
Package cacheutil provides common cache utilities for infrastructure adapters. |
|
interfaces/adapters/systemstatus
Package systemstatus provides shared utilities for system status Redis operations.
|
Package systemstatus provides shared utilities for system status Redis operations. |
|
interfaces/http/handlers/admin
Package admin provides HTTP handlers for administrative operations.
|
Package admin provides HTTP handlers for administrative operations. |
|
interfaces/http/handlers/admin/resourcegroup
Package resourcegroup provides HTTP handlers for admin resource group operations.
|
Package resourcegroup provides HTTP handlers for admin resource group operations. |
|
interfaces/http/handlers/admin/subscription
Package subscription provides HTTP handlers for admin subscription operations.
|
Package subscription provides HTTP handlers for admin subscription operations. |
|
interfaces/http/handlers/common
Package common provides shared HTTP handler utilities.
|
Package common provides shared HTTP handler utilities. |
|
interfaces/http/handlers/forward/agent/api
Package api provides HTTP handlers for forward agent REST API.
|
Package api provides HTTP handlers for forward agent REST API. |
|
interfaces/http/handlers/forward/agent/crud
Package crud provides HTTP handlers for forward agent CRUD management.
|
Package crud provides HTTP handlers for forward agent CRUD management. |
|
interfaces/http/handlers/forward/agent/hub
Package hub provides WebSocket hub handlers for forward agent connections.
|
Package hub provides WebSocket hub handlers for forward agent connections. |
|
interfaces/http/handlers/forward/rule
Package rule provides HTTP handlers for forward rule management.
|
Package rule provides HTTP handlers for forward rule management. |
|
interfaces/http/handlers/forward/subscription
Package subscription provides HTTP handlers for subscription-level forward management.
|
Package subscription provides HTTP handlers for subscription-level forward management. |
|
interfaces/http/handlers/forward/user
Package user provides HTTP handlers for user-level forward management.
|
Package user provides HTTP handlers for user-level forward management. |
|
interfaces/http/handlers/node
Package node provides HTTP handlers for node agent management.
|
Package node provides HTTP handlers for node agent management. |
|
interfaces/http/middleware
Package middleware provides HTTP middleware for the application.
|
Package middleware provides HTTP middleware for the application. |
|
interfaces/http/routes
Package routes provides HTTP route configurations.
|
Package routes provides HTTP route configurations. |
|
shared/biztime
Package biztime provides utilities for business timezone calculations.
|
Package biztime provides utilities for business timezone calculations. |
|
shared/db
Package db provides database utilities including transaction management and query scopes.
|
Package db provides database utilities including transaction management and query scopes. |
|
shared/errors
Package errors provides application-level error types and utilities.
|
Package errors provides application-level error types and utilities. |
|
shared/goroutine
Package goroutine provides utilities for safely launching goroutines with panic recovery.
|
Package goroutine provides utilities for safely launching goroutines with panic recovery. |
|
shared/hubprotocol/forward
Package forward defines the WebSocket hub protocol types for forward agents.
|
Package forward defines the WebSocket hub protocol types for forward agents. |
|
shared/hubprotocol/node
Package node defines the WebSocket hub protocol types for node agents.
|
Package node defines the WebSocket hub protocol types for node agents. |
|
shared/utils/jsonutil
Package jsonutil provides JSON conversion utilities.
|
Package jsonutil provides JSON conversion utilities. |
|
shared/utils/setutil
Package setutil provides generic set utilities for common ID collection patterns.
|
Package setutil provides generic set utilities for common ID collection patterns. |
|
shared/version
Package version provides utilities for semantic version comparison.
|
Package version provides utilities for semantic version comparison. |
|
sdk
|
|
|
agent
module
|
|
|
forward
module
|
Click to show internal directories.
Click to hide internal directories.