mirror of https://github.com/Studio-Saelix/sencho.git synced 2026-07-26 11:49:16 +00:00

Files

T

Anso 9f9de482ce chore: GitHub workflow revamp — GitHub Flow, community files, CI updates (#101 )

* chore: add comprehensive .gitignore

* ci: update CI workflow for GitHub Flow

- Change triggers from develop to main (PRs to main + pushes to main)
- Add concurrency controls to cancel stale runs
- Update docker/build-push-action to v6
- Add descriptive job names for branch protection status checks
- Update screenshot refresh and docs sync to trigger on main pushes

* ci: update docker-publish for GitHub Flow

- Remove develop branch trigger (no more dev tag)
- Keep v* tag trigger for releases
- Update docker/build-push-action to v6

* docs: add community and governance files

- CONTRIBUTING.md with dev setup and PR guidelines
- SECURITY.md with vulnerability reporting policy
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1 reference)
- PR template with conventional commits checklist
- Issue templates for bug reports and feature requests
- CODEOWNERS defaulting to @AnsoCode
- Dependabot config for npm (root, backend, frontend) and GitHub Actions

* docs: add README with badges, quick start, and contributing section

* chore: add LICENSE placeholder and open license decision issue (#100)

* docs: update CLAUDE.md for GitHub Flow branching model

- Replace develop-based Git Flow with GitHub Flow (main only)
- All branches now created off main, PRs target main
- Simplify release checklist (no develop-to-main merge step)
- Update testing strategy to reference Vitest and Playwright
- Fix docs.json reference (was mint.json)

* chore: track CLAUDE.md in version control

Remove CLAUDE.md from .gitignore so project workflow instructions
are versioned alongside the code they govern.

* docs: add MANUAL_STEPS.md for GitHub settings that require UI configuration

2026-03-24 22:32:44 -04:00

2.6 KiB

Raw Blame History

Sencho

A self-hosted Docker Compose management dashboard. Manage your stacks, containers, images, volumes, and networks through a modern web UI.

Features

Stack Management — Create, edit, start, stop, and remove Docker Compose stacks with a built-in Monaco code editor
Multi-Node Support — Manage remote Sencho instances through a transparent HTTP/WebSocket proxy (Distributed API model)
App Store — One-click deployment from LinuxServer.io templates with editable ports, volumes, and environment variables
Resource Hub — Browse and manage images, volumes, and networks with managed/external/unused classification
Live Logs — Aggregated real-time log streaming across all containers with search and filtering
Dashboard — Container stats, CPU/RAM metrics, health checks, and image update notifications
Alerts — Configurable threshold alerts for CPU, RAM, and disk usage
Terminal — In-browser host console and container exec via WebSocket

Quick Start

services:
  sencho:
    image: saelix/sencho:latest
    container_name: sencho
    restart: unless-stopped
    ports:
      - "3000:3000"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/app/data
      # 1:1 Compose Path Rule: host path MUST match container path
      - /opt/docker:/opt/docker
    environment:
      - COMPOSE_DIR=/opt/docker
      - DATA_DIR=/app/data

docker compose up -d

Then open http://your-server:3000 and create your admin account.

See the full documentation for configuration details, multi-node setup, and more.

Development

# Backend (Express + TypeScript)
cd backend && npm install && npm run dev

# Frontend (React + Vite)
cd frontend && npm install && npm run dev

The frontend dev server proxies /api requests to the backend on port 3000.

Contributing

See CONTRIBUTING.md for development setup and PR guidelines.

Security

See SECURITY.md for vulnerability reporting. Do not open public issues for security vulnerabilities.

License

License pending. See issue #100 for the license decision discussion and LICENSE for current status.

2.6 KiB Raw Blame History