Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #35

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update README #35

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52678eb
fix: correct typos in README
Jul 9, 2019
b253f92
refactor: move README installation blurbs to same place
Jul 9, 2019
6f7672a
doc: add section about installing golang
Jul 9, 2019
80ea253
doc: updating install for consistency
Jul 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,25 @@

Implements a connectomics REST interface that leverages the [neuprint](https://github.com/janelia-flyem/neuPrint) data model.

## Installation
## Dependencies
Since neuPrint is written in [golang](https://golang.org), you will need to [download](https://golang.org/dl) and install golang before you can build and run neuPrintHTTP. The build tools for golang are opinionated about the file structure and location of golang projects, but by default the tools will autogenerate the required folders when you `go get` a project.

## Installing

% go get github.com/connectome-neuprint/neuPrintHTTP

## Installing without kafka support

If you are having trouble building the server, because librdkafka is missing and you don't need to send log messages to a kafka server, then try this build.

% go get -tags nokafka github.com/connectome-neuprint/neuPrintHTTP

## Running

% neuprintHTTP -p |PORTNUM| config.json
% neuPrintHTTP -port |PORTNUM| config.json

The config file should contain information on the backend datastore that satisfies the connectomics REST API and the location for a file containing
a list of authorized users. To test https locally and generate the necessary certificates, run:

% go run $GOROOT/src/crypto/tls/generate_cert.go --host localhost

## Installing without kafka support

If you are having trouble building the server, because librdkafka is missing and you don't need to send log messages to a kafka server, then try this build.

% go get -tags nokafka github.com/connectome-neuprint/neuPrintHTTP