mirror of https://github.com/orris-inc/orris.git synced 2026-05-06 21:44:01 +08:00

Files

orris-inc e9a75e379a feat(forward): add TLS tunnel type support and installation script

- Add TunnelType value object supporting ws (WebSocket) and tls modes
- Extend forward rules to support tunnel type configuration
- Add tls_listen_port to agent status for TLS tunnel connections
- Update probe service to select port based on tunnel type
- Update config sync service to include tunnel type in sync data
- Add install.sh one-click installation script
- Add README.md and INSTALL.md documentation in English

2025-12-24 18:45:54 +08:00

1.3 KiB

Raw Blame History

Orris Installation Guide

Requirements

Docker
Docker Compose

Quick Start

1. Clone the Repository

git clone https://github.com/orris-inc/orris.git
cd orris

2. Configure Environment

cp .env.example .env
# Edit .env to configure database, Redis, OAuth, etc.

3. Start Services

docker compose up -d

4. Run Database Migrations

docker exec -it orris_app /app/orris migrate up

Services included:

Caddy - Reverse proxy (80, 443)
Backend - API service (8080)
Frontend - Web application
MySQL - Database (3306)
Redis - Cache (6379)

5. Check Status

docker compose ps
docker compose logs -f

Update Services

docker compose pull
docker compose up -d

Common Commands

Command	Description
`docker compose up -d`	Start services
`docker compose down`	Stop services
`docker compose pull`	Update images
`docker compose logs -f`	View logs

Configuration

Environment variable format: ORRIS_<SECTION>_<KEY>

Required:

ORRIS_SERVER_BASE_URL - Backend service URL

Key settings:

Database: ORRIS_DATABASE_*
Redis: ORRIS_REDIS_*
JWT: ORRIS_AUTH_JWT_SECRET
OAuth: ORRIS_OAUTH_GOOGLE_*, ORRIS_OAUTH_GITHUB_*

See .env.example for details.

1.3 KiB Raw Blame History