Build any realtime experience using Ably’s Pub/Sub Go SDK, supported on all popular platforms and frameworks.
Ably Pub/Sub provides flexible APIs that deliver features such as pub-sub messaging, message history, presence, and push notifications. Utilizing Ably’s realtime messaging platform, applications benefit from its highly performant, reliable, and scalable infrastructure.
Find out more:
Everything you need to get started with Ably:
Ably aims to support a wide range of platforms. If you experience any compatibility issues, open an issue in the repository or contact Ably support.
Important
Go SDK versions < 1.2.14 will be deprecated from November 1, 2025.
To get started with your project, install the package:
~ $ go get -u github.com/ably/ably-go/ablyThe following code connects to Ably's realtime messaging service, subscribes to a channel to receive messages, and publishes a test message to that same channel:
// Initialize Ably Realtime client
client, err := ably.NewRealtime(
ably.WithKey("your-ably-api-key"),
ably.WithClientID("me"),
// Wait for connection to be established
ch := make(chan ably.ConnectionStateChange, 1)
client.Connection.On(ably.ConnectionEventConnected, func(change ably.ConnectionStateChange) {
ch <- change
})
<-ch
fmt.Println("Connected to Ably")
// Get a reference to the 'test-channel' channel
channel := client.Channels.Get("test-channel")
// Subscribe to all messages published to this channel
channel.SubscribeAll(context.Background(), func(msg *ably.Message) {
fmt.Printf("Received message: %s\n", msg.Data)
})
// Publish a test message to the channel
channel.Publish(context.Background(), "test-event", "hello world")
}The ably-go SDK doesn't provide a direct option to set a proxy in its configuration. However, you can use standard environment variables to set up a proxy for all your HTTP and HTTPS connections. The Go programming language will automatically handle these settings.
Set up proxy via environment variables details.
To configure the proxy, set the HTTP_PROXY and HTTPS_PROXY environment variables with the URL of your proxy server. Here's an example of how to set these variables:
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080The proxy.example.com is the domain or IP address of your proxy server and 8080 is the port number of your proxy server.
Include the protocol (http or https) in the proxy URL. If your proxy requires authentication, you can include the username and password in the URL, for example: http://username:[email protected]:8080.
After setting the environment variables, the ably-go SDK will route its traffic through the specified proxy for both Rest and Realtime clients.
For more details on environment variable configurations in Go, see Go documentation on http.ProxyFromEnvironment.
Set up proxy via custom http client details.
For Rest client, you can also set proxy by providing custom http client option ably.WithHTTPClient:
ably.WithHTTPClient(&http.Client{
Transport: &http.Transport{
Proxy: proxy // custom proxy implementation
},
})Connection reliability is totally dependent on health of proxy server and ably will not be responsible for errors introduced by proxy server.
The CHANGELOG.md contains details of the latest releases for this SDK. You can also view all Ably releases on changelog.ably.com.
Read the CONTRIBUTING.md guidelines to contribute to Ably.
For help or technical support, visit Ably's support page or GitHub Issues for community-reported bugs and discussions.
Version 1.2 introduced significant breaking changes from 1.1.5. See the Upgrade / Migration Guide for details on what changes are required in your code.
- Push notification target functionality is not applicable to this SDK.
- No support for Push Notifications Admin API.
- Partial support for Channel Suspended State.
- Ping functionality is not implemented.
- Delta compression is not implemented.
- Push notification target functionality is not applicable to this SDK.
- No support for Push Notifications Admin API.