Skip to content

CSSE497/pathfinder-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pathfinder API Server

Build Status Coverage Status

This server exposes https://api.thepathfinder.xyz, the websocket API that powers the Pathfinder SDKs. Pathfinder users do not need to be familiar with this service as it is entirely wrapped by the Pathfinder SDKs.

Development Guide

These instructions exist mostly as a reference for the development team.

Local development

The server can be run and debugged locally with

activator "~run"

Standalone release

A standalone release can be built with

activator dist

This release can be run with

unzip -d /opt target/universal/pathfinder-server-<version>.zip
/opt/pathfinder-server-<version>/bin/pathfinder-server -Dhttp.port=80 -Dhttps.port=443 -Dplay.server.https.keyStore.path=<path to jks> -Dplay.server.https.keyStore.password=<jks password>

Docker

A Docker image cant be built with

activator docker:publishLocal

The image can be run locally with

docker run -p 9000:9000 pathfinder-server:<version>

The image can be pushed to gcloud with

gcloud docker push beta.gcr.io/<gcloud project id>/pathfinder-server:<version>

The running Docker container can be updated with

kubectl rolling-update pathfinder-server --image=beta.gcr.io/<gcloud project id>/pathfinder-server:<version>

Detailed GCR release instructions

  1. Increase the version number in build.sbt and tag the repository
vi build.sbt
git tag -a v0.1.1
git push --tag
  1. Ensure that Docker is up and running
docker-machine start default
eval "$(docker-machine env default)"
  1. Authenticate Docker to GCR
docker login -e <email> -u _token -p "$(gcloud auth print-access-token)" https://beta.gcr.io
  1. Build the image and push it to GCR (as defined in build.sbt)
activator docker:publish
  1. Update the pods
kubectl rolling-update pathfinder-server --image=beta.gcr.io/<gcloud project id>/pathfinder-server:<version>

License

MIT.

About

The backend for the Pathfinder service.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •