whatsignal

KO | EN

gitlite — search

#react #typescript #llm #golang #rust #deep-learning #linux #nodejs #awesome #cli #kubernetes #vue #pytorch #security

(★ 19)

WhatSignal is a bridge/relay between WhatsApp and Signal

whatsignal 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WhatSignal

[![Version](https://img.shields.io/badge/version-1.2.54-blue.svg)](https://raw.githubusercontent.com/bikemazzell/whatsignal/main/CHANGELOG.md)
[![Go Version](https://img.shields.io/badge/go-1.26+-blue.svg)](https://raw.githubusercontent.com/bikemazzell/whatsignal/main/go.mod)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/bikemazzell/whatsignal/main/LICENSE)

WhatSignal is a self-hosted bridge between WhatsApp and Signal. Messages go both ways — text, images, videos, voice notes, reactions — and reply threading is preserved across protocols. You read and reply from Signal; the person on WhatsApp doesn't know the difference.

## Features

- Bidirectional WhatsApp-Signal bridge (individual and group chats)
- Quoted replies route to the correct contact, even across different message ID schemes
- Contact names resolved from cache, with fallback to phone numbers
- Images, videos, documents, voice notes in both directions
- Typing indicators, read receipts, reactions, delivery tracking
- AES-256-GCM field encryption, webhook HMAC auth, configurable data retention
- Health endpoint, structured JSON logs, circuit breakers, graceful retries
- Dockerized, 80%+ test coverage

Bridged read state is asymmetric by design: WhatsApp chats are only marked seen after a verified Signal read receipt for the bridged message, while WhatsApp delivery and read acknowledgments continue to update WhatSignal's stored status for Signal-originated messages.

## Prerequisite Accounts
To use WhatSignal, you must have:

1. **WhatsApp Number**: Registered and active, activated as a session on WAHA.
2. **Signal Bridge Number**: Dedicated for the bridge, used by Signal-CLI, and different from the _destination_ number.
3. **Signal Destination Number**: The final recipient, typically on your mobile or desktop Signal app. This must not be the same as the _bridge_ number.

## Quick Start

### Deploy with Pre-built Image (Easiest)

**One-liner deployment (no source code needed):**
```bash
curl -fsSL https://raw.githubusercontent.com/bikemazzell/whatsignal/main/scripts/deploy.sh | bash
```

**Then follow the [Quick Start Checklist](docs/quickstart.md) for complete setup steps.**

**Manual deployment:**
```bash
# Download deployment script
curl -fsSL https://raw.githubusercontent.com/bikemazzell/whatsignal/main/scripts/deploy.sh -o deploy.sh
chmod +x deploy.sh
./deploy.sh

# Configure your settings
cd whatsignal-deploy
nano .env          # API keys and secrets
nano config.json   # Signal/WhatsApp phone numbers

# Start services
docker compose up -d

# Check status (use /healthz for "is it running"; /health is readiness and
# returns 503 until WAHA and Signal are reachable)
docker compose ps
curl http://localhost:8082/healthz
```

**For detailed deployment instructions, see:** [Deployment Guide](docs/deployment.md)

### Required environment variables (secure mode)

WhatSignal runs in **secure mode by default** — it refuses to start unless the
following are set. Secure mode is active for any value of `WHATSIGNAL_ENV`
except `development`.

| Variable | Requirement |
|----------|-------------|
| `WHATSIGNAL_ADMIN_TOKEN` | Required, **≥ 32 chars**. Generate: `openssl rand -hex 32` |
| `WHATSIGNAL_WHATSAPP_WEBHOOK_SECRET` | Required, **≥ 32 chars**. Generate: `openssl rand -hex 32` |
| `WHATSIGNAL_ENCRYPTION_SECRET` | Required when encryption is enabled, **≥ 32 chars** |
| `WHATSIGNAL_ENCRYPTION_SALT` | Required, **≥ 16 chars** |
| `WHATSIGNAL_ENCRYPTION_LOOKUP_SALT` | Required, **≥ 16 chars** |

If any is missing the process exits with, e.g.,
`failed to load config: WHATSIGNAL_ADMIN_TOKEN is required in secure mode`.
Setting `WHATSIGNAL_ENV=development` disables these checks but is **not**
recommended for any internet-reachable deployment. See
[Configuration → Secure mode](docs/configuration.md#secure-mode).

> **Upgrading from < 1.2.52:** secure mode changed from opt-in
> (`WHATSIGNAL_ENV=production`) to **on by default**, and `WHATSIGNAL_ADMIN_TOKEN`
> is now mandatory at startup. If you previously relied on the built-in default
> salts (i.e. you never set `WHATSIGNAL_ENCRYPTION_SALT` /
> `WHATSIGNAL_ENCRYPTION_LOOKUP_SALT`), set them explicitly to
> `whatsignal-salt-v1` and `whatsignal-lookup-salt-v1` to keep existing encrypted
> data readable, or accept that the message-mapping cache resets.

The health endpoint also split in 1.2.52: `/healthz` is liveness (200 once the
process is up) and `/health` is readiness (503 while WhatsApp/Signal are
unreachable). Use `/healthz` for container/orchestrator liveness probes.

### Build from Source (Developers)

**For development or customization:**
```bash
git clone https://github.com/bikemazzell/whatsignal.git
cd whatsignal
./scripts/setup.sh  # Creates .env and config.json
make docker-up      # Build and start all services
```

### Docker Commands

```bash
make docker-up         # Start all services
make docker-down       # Stop all services  
make docker-logs       # Follow logs
make docker-status     # Check service status
make docker-restart    # Restart services
make docker-clean      # Clean up everything
```

### Troubleshooting

**Services won't start:**
```bash
# Check service status
make docker-status

# View logs for issues
make docker-logs

# Restart services
make docker-restart
```

**Port conflicts:**
- WhatSignal host port: 8083
- WAHA: Compose network only by default
- Signal-CLI: Compose network only by default

**Clean slate restart:**
```bash
make docker-clean     # Removes all data!
./scripts/setup.sh    # Recreate config
make docker-up        # Start fresh
```

## Documentation

### Getting Started
- [Quick Start Checklist](docs/quickstart.md) - Step-by-step deployment checklist
- [Deployment Guide](docs/deployment.md) - Complete deployment instructions

### Configuration & Operations  
- [Configuration Guide](docs/configuration.md) - Configuration options and settings
- [Security Guide](docs/security.md) - Encryption and security features

### Development
- [Development Guide](docs/development.md) - Contributing and development setup
- [Technical Requirements](docs/requirements.md) - Design specifications
- [Release Process](docs/release.md) - Version management and releases

## Contributing

1. Fork the repository
2. Create your feature branch
3. Write tests for new functionality
4. Update documentation
5. Submit pull request

See [Development Guide](docs/development.md) for detailed instructions.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Acknowledgments

- [Waha](https://github.com/devlikeapro/waha) for the WhatsApp HTTP API
- [signal-cli-rest-api](https://github.com/bbernhard/signal-cli-rest-api) for the Signal CLI interface

whatsignal

whatsignal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

whatsignal

whatsignal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README