Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 918 Bytes

README.md

File metadata and controls

27 lines (24 loc) · 918 Bytes

Synapse Interactive Docs

This is a repository for the proof of concept of the jupyter based documentation for Synapse.

Steps to get started

  • Clone the repository:
git clone https://github.com/mattfazza/synapse_interactive_docs.git
  • Navigate into its folder:
cd synapse_interactive_docs
  • Copy your .synapseConfig file into this directory - if you wish to use your synapse configuration to log in, you can do so by copying it into this directory:
cp ~/.synapseConfig .
  • Build the image using the docker file provided:
docker build -t synapse_interactive_docs ./
  • Create the container exposing the correct port, and binding the correct folder:
docker run -it -p 8888:8888 --mount type=bind,source=$(pwd),target=/home/jovyan/synapse_interactive_docs synapse_interactive_docs:latest
  • Open the notebook server following the prompt on your terminal