GitHub

Community

Console

Overview

SDKs

Introduction

Any application of any size, language or framework can be deployed to Hop. Deployments are Ignite's primary abstraction - containers run inside them

Deploying to Hop

How to deploy a Node.js app server on Hop in less than 2 minutes

Node.js Express App

Learn how to deploy Redis with persistence enabled to Hop in seconds

Redis

Elixir Cluster

The Hop CLI allows you to manage and control every aspect of your Hop projects. It acts as a command-line replacement for the Hop Console with some extra features to support Hop deployments

Hop CLI supports tab completion for bash, zsh and fish

Completions

Hop CLI Completions

Since the CLI has a *nix download script it can be easily used in headless / continuous integration environments

Working in CI

Ignite is the pragmatic app deployment platform: deploy and scale any application worldwide.

Ignite

Gateways allow you to expose your Hop deployments to your project or the internet

Gateways

Learn about how private networking works in Hop

Private Networking

Volumes allow you to persist data across containers - perserving your deployment's state after restarts

Persistent Volumes

Enable zero-downtime, fault tolerant deployments with health checks

Health Checks

Project secrets act as a global secure secret store for each project on Hop. Secrets can be referenced in deployments as environment variables and will automatically be populated when a container starts

Project Secrets

When creating a deployment, you can specify an image from a remote registry (such as Dockerhub or GCR), or you can use the Hop Image Registry

Images

When deploying with GitHub, Hop will automatically infer your build environment and initiate a build for each push to git

Builds

Using the CLI, you can port-forward deployments to access them securely without having to expose them to the public internet

Port Forwarding

Node

Python

Elixir

Rust

Physical Hop points of presence & peering policy

Regions

Hop Regions

Learn about how you can utilize Hop webhooks in your applications to be notified of events in your project.

Webhooks

REST API

Project tokens allow you to create permission-based API keys to use with the Hop API or SDKs

Project Tokens

Learn about how Hop handles billing for your projects

Billing & Free Trial

Billing Overview

The Hop JS Client SDK allows you to interact with Hop products from your frontend application.

JavaScript

JS Client SDK

The Hop React library allows you to easily integrate Hop products, such as Channels and Pipe, into your frontend.

React

React SDK

The Hop server-side JS SDK allows you to interact with all Hop products on the server side.

Server-side JS SDK

Channels allows you to easily create direct or grouped realtime message channels between users, server-side applications, IoT devices and more. You can use them to publish realtime events & even store realtime state objects which you can handle using our client-side SDKs.

As well as transient messages, channels can be used as a store for realtime, stateful and persisted state. You can think of it like a realtime database attached to every channel.

Channel State

Tokens

Pipe Overview

Pipe allows you to deliver real-time livestreams to users across the globe withour worrying about scale. As a developer, Pipe is easy to integrate - there's only 3 steps to getting your first broadcast going.

Getting Started

Pipe Getting Started

You can use our client (frontend) SDKs to easily implement Pipe into your product.

Client Implementation

Pipe Client Implementation

Pipe supports multiple ingest protocols for sending streams to Pipe: RTMP and RTP (MPEG-TS). You can set the ingest protocol to use when creating a Pipe room.

Name	Language	URL	Official	Documentation
@onehop/client	TypeScript	npmjs.com/package/@onehop/client	✅	/sdks/client/js
@onehop/react	TypeScript	npmjs.com/package/@onehop/client	✅	/sdks/client/react

Name	Language	URL	Official	Documentation
@onehop/js	TypeScript	npmjs.com/package/@onehop/js	✅	/sdks/server/js
hop-go	Golang	github.com/hopinc/go	✅	/sdks/server/go-api

Getting Started

CLI

Ignite

Reference

SDKs

Other Products

SDKs

Client Side

Server Side

REST API

Getting Started

CLI

Ignite

Reference

SDKs

Other Products

​Client Side

​Server Side

​REST API

Client Side

Server Side

REST API