dispatch/README.md
Ken-Håvard Lieng abc495f849 Update README
2018-05-16 03:54:19 +02:00

2.2 KiB

dispatch Build Status

Try it!

Dispatch

Features

  • Searchable history
  • Persistent connections
  • Multiple servers and users
  • Automatic HTTPS through Let's Encrypt
  • Client certificates

Usage

There is a few different ways of getting it:

1. Binary

2. Go

This requires a Go environment, version 1.8 or greater.

Fetch, compile and run dispatch:

go get github.com/khlieng/dispatch
dispatch

To get some help run:

dispatch help

3. Docker

docker run -p <http port>:80 -p <https port>:443 -v <path>:/data khlieng/dispatch

Build

Server

cd $GOPATH/src/github.com/khlieng/dispatch
go install

Client

This requires Node.js and yarn.

Fetch the dependencies:

go get github.com/jteeuwen/go-bindata/...
yarn global add gulp@next
cd $GOPATH/src/github.com/khlieng/dispatch/client
yarn

Run the build:

gulp build

The server needs to be rebuilt to embed new client builds.

For development with hot reloading enabled run:

gulp
dispatch --dev

Libraries

The libraries this project is built with.

Server

Client