Skip to content
Enterprise Jupyter notebook sharing and collaboration app
Ruby HTML JavaScript CSS Shell Dockerfile CoffeeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ebextensions added ebextensions to enable EPEL and install ssdeep-devel Feb 23, 2017
app Some performance optimizations Aug 9, 2019
bin Ha jk - for real this time Jan 10, 2017
config Back-end helpers for reviews and revisions Aug 2, 2019
db Add review status to notebook summary Apr 19, 2019
docker/config Solr configuration fixes in docker compose (#28) Dec 15, 2018
docs Update git repo notes Jun 16, 2019
extensions Update gems for mac compatibility Sep 11, 2018
lib
public fix typo Jul 14, 2018
samples
script Make easier to run jobs outside the app Feb 14, 2019
test RuboCop cleanup Jul 24, 2018
vendor/assets catching beta branch up to master Sep 13, 2018
.dockerignore Clean up docker image Jan 14, 2017
.gitignore Back-end and UI stub for diff between revisions Aug 3, 2018
.overcommit.yml Ha jk - for real this time Jan 10, 2017
.rubocop.yml Update rubocop config Aug 3, 2018
.rubocop_todo.yml Ha jk - for real this time Jan 10, 2017
Dockerfile Need libfuzzy for ssdeep Feb 2, 2017
Gemfile Security updates Dec 7, 2018
Gemfile.lock Security update Jun 16, 2019
LICENSE adding MIT license Jan 12, 2017
README.md link to scheduled job notes Feb 14, 2019
Rakefile RuboCop cleanup Jul 24, 2018
_config.yml Set theme jekyll-theme-cayman Apr 17, 2017
config.ru Ha jk - for real this time Jan 10, 2017
docker-compose-with-jupyter.yml Allow for a password Jan 28, 2019
docker-compose.yml Optionally create an admin user at startup Feb 10, 2019
docker-entrypoint.sh Fix docker startup #32 Jul 19, 2018
docker-run.sh Additional required ENV settings May 1, 2017

README.md

nbgallery

nbgallery (notebook gallery) is an enterprise Jupyter notebook sharing and collaboration platform. For an overview, please check out our github.io site.

nbgallery screenshot

Tony Hirst published a nice walkthrough of some of the features of nbgallery on his blog.

Getting Started

Requirements

nbgallery is a Ruby on Rails application. You can run it with the built-in rails server command or with Rack servers like Puma or Passenger.

The nbgallery application requires a MySQL or MariaDB server. Other SQL-based servers may work but have not been tested. We recommend creating a separate mysql user account for use by the app.

The application also requires an Apache Solr server for full-text indexing. For small to medium instances (small thousands of notebooks and users), the bundled sunspot Solr server may suffice. Larger instances may require a standalone server. See our notes for more detail.

Installation

You can install nbgallery on various platforms:

Configuration

Most configuration settings will should work out of the box, but there are a few things you'll need to set up. See our configuration notes for more detail.

Running the server

Once everything is configured, you're ready to go! See this page for details on starting up the app and shutting it down.

Jupyter integration

One of the benefits of nbgallery is its two-way integration with Jupyter. You can launch notebooks from nbgallery into Jupyter with a single click. Within Jupyter, the Gallery menu enables you to save notebooks to nbgallery and submit change requests to other notebook authors. See this page for more information.

Selected topics

Here is some documentation on various features of nbgallery:

Contributions

Issues and pull requests are welcome. For code contributions, please note that we use rubocop (our config), so please run overcommit --install in your project directory to activate the git commit hooks.

You can’t perform that action at this time.