-
-
Notifications
You must be signed in to change notification settings - Fork 53
Installation
- First time setting up neffos in a Go project.
- Upgrading to a newer release.
- Go 1.21 or newer. (Current development targets Go 1.26 — see
go.mod.) - One of the supported WebSocket adapters (gorilla or gobwas) — both are pulled in transitively, you don't install them separately.
go get github.com/kataras/neffos@latestOr pin in your go.mod:
module your_project_name
go 1.21
require (
github.com/kataras/neffos v0.0.22
)If you're starting a new project, prefer
@latest. Pin a specific version once you ship to production.
Verify the install with a one-liner:
package main
import (
"fmt"
_ "github.com/kataras/neffos"
)
func main() { fmt.Println("neffos installed") }Network errors during go get usually mean GOPROXY is misconfigured. Reset to the default:
go env -w GOPROXY=https://proxy.golang.org,directIf you're behind a corporate proxy, replace https://proxy.golang.org with your internal Go module proxy.
go get -u github.com/kataras/neffos@latestPrefer tagged releases for production. The master branch is usually stable but may include unreleased changes — use it only when you need a specific unreleased fix.
For the JavaScript/TypeScript client, see neffos.js:
npm install neffos.jsTypes are bundled — no separate @types/* install required.
- Getting Started — the first runnable example
- Examples — catalog of complete example apps
- Architecture — what's under the hood once neffos is in
Home | About | Project | Getting Started | Technical Docs | Copyright © 2019-2023 Gerasimos Maropoulos. Documentation terms of use.
Getting started
Concepts
Messaging
Production
Scale out