Nomploy Nomad Packs

← All packs

soketi v0.1.0

Messaging

soketi — a fast, open-source WebSocket server that is protocol-compatible with Pusher Channels, for real-time features (live updates, notifications, presence) in your apps. Deployed as a stateless host-networked Nomad service with a default app credential set. A self-hosted drop-in for Pusher.

nomad-pack run soketi --registry nomploy

Source ↗ Project ↗ ★ 5.6k

1 task ws 6001metrics 9601 image quay.io/soketi/soketi:latest-16-alpine
Variables 11
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run soketi -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "soketi"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The soketi container image. Pin a tag in production.
image = "quay.io/soketi/soketi:latest-16-alpine"

# Host port for the WebSocket server (SOKETI_PORT).
port = 6001

# Host port for the Prometheus metrics endpoint.
metrics_port = 9601

# Default app id (SOKETI_DEFAULT_APP_ID).
app_id = "app-id"

# Default app key (SOKETI_DEFAULT_APP_KEY). CHANGE THIS.
app_key = "app-key"

# Default app secret (SOKETI_DEFAULT_APP_SECRET). CHANGE THIS.
app_secret = "app-secret"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }
NameTypeDefaultDescription
job_name string 
"soketi"
 The name of the Nomad job.
namespace string 
"default"
 The Nomad namespace to deploy into.
datacenters list 
["*"]
 The datacenters to deploy to.
image string 
"quay.io/soketi/soketi:latest-16-alpine"
 The soketi container image. Pin a tag in production.
port number 
6001
 Host port for the WebSocket server (SOKETI_PORT).
metrics_port number 
9601
 Host port for the Prometheus metrics endpoint.
app_id string 
"app-id"
 Default app id (SOKETI_DEFAULT_APP_ID).
app_key key string 
"app-key"
 Default app key (SOKETI_DEFAULT_APP_KEY). CHANGE THIS.
app_secret key string 
"app-secret"
 Default app secret (SOKETI_DEFAULT_APP_SECRET). CHANGE THIS.
constraints list 
[]
 Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object 
{
    cpu    = 300
    memory = 256
  }
 The task resources.
Readme

soketi

soketi — a fast, open-source WebSocket server that is protocol-compatible with Pusher Channels, for real-time features (live updates, notifications, presence). A self-hosted drop-in for Pusher.

Stateless host-networked Nomad service with a default app credential set.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run soketi --registry=nomploy

Configure

Variable Default Description
port 6001 WebSocket port (SOKETI_PORT).
metrics_port 9601 Prometheus metrics port.
app_id / app_key / app_secret app-id / app-key / app-secret Default app credentials. Change them.
image quay.io/soketi/soketi:latest-16-alpine Image. Pin a tag in production.
resources { cpu = 300, memory = 256 } Task resources.

Configure a Pusher-compatible client with the app id/key/secret above and host = <node-ip>, port = 6001, forceTLS: false. State is in-memory (single node) — front with TLS for browser clients and change the default credentials.