If you find this add-on useful, please star it on GitHub — stars show appreciation and help maintainers know their work matters.
DDEV Sockudo
Overview
This add-on integrates Sockudo into your DDEV project.
Installation
ddev add-on get AlexHL02/ddev-sockudo
ddev restart
After installation, make sure to commit the .ddev directory to version control.
Usage
| Command | Description |
|---|---|
ddev describe |
View service status and used ports for Sockudo |
ddev logs -s sockudo |
Check Sockudo logs |
Connecting
Use the following URLs to connect your Pusher-compatible client:
| Protocol | URL |
|---|---|
| WebSocket (WS) | ws://<project>.ddev.site:6001/app/<SOCKUDO_APP_KEY> |
| WebSocket Secure (WSS) | wss://<project>.ddev.site:6002/app/<SOCKUDO_APP_KEY> |
With the default credentials:
host: <project>.ddev.site
port: 6001 (ws) / 6002 (wss)
key: app-key
secret: app-secret
app_id: app-id
Advanced Customization
To change the Sockudo version:
ddev dotenv set .ddev/.env.sockudo --sockudo-version="v4.5.1"
ddev add-on get AlexHL02/ddev-sockudo
ddev restart
Make sure to commit the .ddev/.env.sockudo file to version control.
All customization options (use with caution):
| Variable | Flag | Default |
|---|---|---|
SOCKUDO_DOCKER_IMAGE |
--sockudo-docker-image |
ubuntu:22.04 |
SOCKUDO_VERSION |
--sockudo-version |
v4.5.1 |
SOCKUDO_HOSTNAME |
--sockudo-hostname |
sockudo |
SOCKUDO_HOST |
--sockudo-host |
0.0.0.0 |
SOCKUDO_PORT |
--sockudo-port |
6001 |
SOCKUDO_HTTPS_PORT |
--sockudo-https-port |
6002 |
SOCKUDO_APP_ID |
--sockudo-app-id |
app-id |
SOCKUDO_APP_KEY |
--sockudo-app-key |
app-key |
SOCKUDO_APP_SECRET |
--sockudo-app-secret |
app-secret |
SOCKUDO_REDIS_HOST |
--sockudo-redis-host |
redis |
SOCKUDO_REDIS_PORT |
--sockudo-redis-port |
6379 |
SOCKUDO_REDIS_DB |
--sockudo-redis-db |
0 |
SOCKUDO_REDIS_PASSWORD |
--sockudo-redis-password |
`` |
SOCKUDO_METRICS_ENABLED |
--sockudo-metrics-enabled |
false |
Credits
Contributed and maintained by @AlexHL02
If you find this add-on useful, please star it on GitHub — stars show appreciation and help maintainers know their work matters.