https://github.com/ably/ably-go
Go client library SDK for Ably realtime messaging service
https://github.com/ably/ably-go
client-library go golang realtime realtime-messaging rest sdk
Last synced: 23 days ago
JSON representation
Go client library SDK for Ably realtime messaging service
- Host: GitHub
- URL: https://github.com/ably/ably-go
- Owner: ably
- License: apache-2.0
- Created: 2014-12-01T11:57:59.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2026-04-20T09:44:00.000Z (23 days ago)
- Last Synced: 2026-04-20T10:15:20.711Z (23 days ago)
- Topics: client-library, go, golang, realtime, realtime-messaging, rest, sdk
- Language: Go
- Homepage: https://ably.com/download
- Size: 4.05 MB
- Stars: 93
- Watchers: 25
- Forks: 32
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Maintainers: MAINTAINERS.md
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/ably/ably-go/ably)
[](https://github.com/ably/ably-go/blob/main/LICENSE)
---
# Ably Pub/Sub Go SDK
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:
* [Ably Pub/Sub docs.](https://ably.com/docs/basics)
* [Ably Pub/Sub examples.](https://ably.com/examples?product=pubsub)
---
## Getting started
Everything you need to get started with Ably:
* [Getting started in Pub/Sub using Go.](https://ably.com/docs/getting-started/go)
* [SDK Setup for Go.](https://ably.com/docs/getting-started/setup?lang=go)
---
## Supported platforms
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](https://ably.com/support).
> [!IMPORTANT]
> Go SDK versions < 1.2.14 will be [deprecated](https://ably.com/docs/platform/deprecate/protocol-v1) from November 1, 2025.
---
## Installation
To get started with your project, install the package:
```bash
~ $ go get -u github.com/ably/ably-go/ably
```
---
## Usage
The 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:
```go
// 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")
}
```
---
## Proxy
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:
```bash
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080
```
The `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:password@proxy.example.com: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](https://golang.org/pkg/net/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`:
```go
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.
---
## Releases
The [CHANGELOG.md](./CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
---
## Contributing
Read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to contribute to Ably.
---
## Support, feedback and troubleshooting
For help or technical support, visit Ably's [support page](https://ably.com/support) or [GitHub Issues](https://github.com/ably/ably-go/issues) for community-reported bugs and discussions.
---
### Breaking API Changes in Version 1.2.x
Version 1.2 introduced significant breaking changes from 1.1.5. See the [Upgrade / Migration Guide](UPDATING.md) for details on what changes are required in your code.
#### REST API
- [Push notification target](https://ably.com/docs/account/app/notifications#push-notification-target) functionality is not applicable to this SDK.
- No support for [Push Notifications Admin API.](https://ably.com/docs/api/rest-sdk/push-admin)
#### Realtime API
- Partial support for [Channel Suspended State.](https://github.com/ably/ably-go/issues/568)
- Ping functionality is not implemented.
- [Push notification target](https://ably.com/docs/account/app/notifications#push-notification-target) functionality is not applicable to this SDK.
- No support for [Push Notifications Admin API.](https://ably.com/docs/api/realtime-sdk/push-admin)