nordrelay
Health Uyari
- License — License: MIT
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 5 GitHub stars
Code Basarisiz
- process.env — Environment variable access in e2e/webui-runtime.spec.ts
- network request — Outbound network request in e2e/webui-runtime.spec.ts
- Hardcoded secret — Potential hardcoded credential in e2e/webui-runtime.spec.ts
- exec() — Shell command execution in plugins/nordrelay/scripts/nordrelay.mjs
- os.homedir — User home directory access in plugins/nordrelay/scripts/nordrelay.mjs
- process.env — Environment variable access in plugins/nordrelay/scripts/nordrelay.mjs
- network request — Outbound network request in plugins/nordrelay/scripts/nordrelay.mjs
Permissions Gecti
- Permissions — No dangerous permissions requested
Bu listing icin henuz AI raporu yok.
NordRelay is a secure remote control bridge for coding agents, connecting Codex, Pi, Hermes, OpenClaw and Claude Code to Telegram, Discord, Slack, WebUI with streaming replies, sessions, files, voice, queues, artifacts and access controls.
NordRelay
NordRelay is a secure remote control plane for coding agents. It connects Codex, Pi, Hermes, OpenClaw, and Claude Code sessions to Telegram, Discord, Slack, the WebUI, and trusted peer nodes, with streaming replies, file/photo/voice input, queues, artifacts, user permissions, and multi-host control.
Use the README for the first install and quick start. Full feature, command, configuration, deployment, and architecture details live in docs/.
Quick Start
Requirements:
- Node.js 22 or newer.
- At least one supported coding agent installed and authenticated, for example Codex CLI.
- A Telegram, Discord, or Slack bot/app token if you want chat access.
Install NordRelay globally:
npm install -g @nordbyte/nordrelay
nordrelay init
nordrelay doctor
nordrelay start
Open the dashboard:
nordrelay web
The dashboard is available at the URL printed by the command, usually:
http://127.0.0.1:31878/
On first WebUI startup, create the first admin user. After that, every dashboard page and chat adapter action is controlled by NordRelay users, groups, linked Telegram/Discord/Slack accounts, and registered channels.
Minimal Setup
The recommended setup path is interactive:
nordrelay init
nordrelay user list
nordrelay doctor
nordrelay start
nordrelay init writes private runtime config to:
~/.nordrelay/nordrelay.env
A minimal Telegram + Codex configuration looks like this:
TELEGRAM_ENABLED=true
TELEGRAM_BOT_TOKEN=123456789:replace-me
DISCORD_ENABLED=false
SLACK_ENABLED=false
NORDRELAY_CODEX_ENABLED=true
NORDRELAY_DEFAULT_AGENT=codex
CODEX_SANDBOX_MODE=workspace-write
CODEX_APPROVAL_POLICY=never
For guided setup in the browser, open the WebUI, go to Settings, then use Setup wizard for Telegram, Discord, or Slack.
Common Commands
CLI:
nordrelay status
nordrelay doctor
nordrelay web
nordrelay restart
nordrelay update
Chat adapters share the core command set:
/help
/session
/sessions
/agent
/model
/reasoning
/queue
/artifacts
/mirror
/stop
/diagnostics
See Commands for the complete Telegram, Discord, Slack, queue, artifact, mirror, update, and diagnostic command reference.
What NordRelay Provides
- Independent sessions per Telegram chat/topic, Discord DM/channel/thread, Slack DM/channel/thread, WebUI, and peer target.
- Streaming replies, typing/status indicators, tool activity, queue handling, retry, abort/stop, and CLI handback.
- File, photo, voice/audio, and generated artifact workflows.
- Per-user and per-group access control for WebUI and chat adapters.
- Optional peer federation for controlling agents on other trusted NordRelay hosts.
- WebUI dashboard for chat, sessions, settings, logs, diagnostics, updates, artifacts, peers, metrics, and users.
- Agent adapters for Codex, Pi, Hermes, OpenClaw, and Claude Code.
- Chat adapters for Telegram, Discord, and Slack.
Documentation
| Topic | Link |
|---|---|
| Full feature list and adapter capabilities | docs/features.md |
| First-run setup, users, running modes, and WebUI | docs/setup.md |
| Telegram, Discord, Slack, and WebUI commands | docs/commands.md |
| Files, photos, voice, transcription, and artifacts | docs/workflows.md |
| Environment variables and launch profiles | docs/configuration.md |
| Security notes and troubleshooting | docs/security-troubleshooting.md |
| Deployment with npm, foreground, Docker, launchd, and systemd | docs/deployment.md |
| Codebase architecture and module map | docs/architecture.md |
| Public security policy | SECURITY.md |
| Contribution guide | CONTRIBUTING.md |
Development
From a source checkout:
npm install
npm run build
npm run check
npm test
npm run test:e2e
Useful runtime scripts:
npm run foreground
npm start
npm run status
npm stop
Security Defaults
- The dashboard requires login.
- Chat adapter access requires linked NordRelay users and registered/allowed channels.
- Peer serving is disabled by default and requires explicit pairing.
- Unsafe launch profiles are hidden unless explicitly enabled.
- Secrets belong in
~/.nordrelay/nordrelay.envor host secret management, not in the repository.
License
MIT. See LICENSE.
Yorumlar (0)
Yorum birakmak icin giris yap.
Yorum birakSonuc bulunamadi