Release 2.2.0

This is a big release that contains a load of development work carried out between 2019-2022, funded by the Horizon 2020 Marketplace project (https://www.the-marketplace-project.eu/)

It mainly includes maintenance updates to support later versions of core technologies (JupyterHub, Docker etc.), as well as some additional features requested by app developers.

Features:

• Inclusion of (optional) license key in ApplicationPolicy object (#544)
• Inclusion of Nginx template scripts for setting up a reverse proxy (#544)
• Inclusion of BasicAuthenticator class for simple demo deployments (#544)
• Supports additional OAuth services using oauthenticator package (#544)
• Extend Configurables framework to enable declaring a startup file (#560, #564, #568)
• Supports declaring a demo set of applications that all users are automatically granted access to (#554, #569)
• Add Spawner options to enable admins to spawn user sessions (#598)

Fixes:

• Fixed broken Sphinx documentation builds on RTD (#575, #577, #582, #600)

Removals:

• Replaced insecure authentication with between remoteappmanager and JupyterHub with OAuth protocol
• Replace deprecated tornado.testing.LogTrapTestCase test case class with ExpectLog (#544)
• Remove AsyncTestCase patch for older versions of tornado.testing (#544)

Maintenance:

• Support for Ubuntu 18.0.4 and CentOS7 deployments (#544)
• Update NodeJS to use 14.x.x series
• Update jupyterhub framework to version 0.9.6 (#552, #604)
• Update requests library to version 2.20.0 (#606)
• Updated tornado package to version 5.1.1 (#544)
• Update docker-py library to version 2.2 (#602)
• Updated dependency versions (now install astor through PyPi) (#544)
• Docker compose scripts included to build SR docker image for debug purposes (#544)

Other:

• Updated documentation (#544, #583)
• Included geckodriver installation for selenium testing (#544)
• Adopted GitHub Actions CI, running Ubuntu 18.04 and CentOS 7 (#554, #558)
• Added cron job to run CI regularly twice a month (#576)

Simphony Remote 2.1.0

• Improve the quit and share application links:

  • Improve the rendering aspect when those links are disabled (#506)
  • Rename "Stop application" link to "Quit" (#519)
  • Rename "Share (copy url)" link to "Share session" (#519)
  • Move the share link above the quit link (#519)
  • Those links now opens modal dialogs, a confirmation dialog for the quit link
    and a dialog containing the application url and a share button for the share
    link (#519)
  • Disable the share link for web applications (#523)

• Autofill available images in the new accounting dialog and let the admin
  choose the new application using a combo-box instead of typing the application
  name (#511)

• Add rendering support for a big application list (#520)

• Add SimPhoNy logo to the login page (#528)

• Improve the admin home view by using an AdminLTE table instead of a basic
  Bootstrap table (#537)

• Display AdminLTE loading spinner when starting and stopping applications
  (#539)

• Add application logo to the start form on the user page (#541)

• Report failure of unfound image when trying to grant access to unknown image
  to a user (#542)

• Use deployment version of Vue instead of development version (#543)

• Add column formatters for the datatable component (#530)

• Fixes:

  • Changing the URL user id number in admin accounting panel now refresh the
    table (#509)
  • HTML input elements are not closed anymore (#524). They were not supposed to
    be closed (see HTML documentation).
  • Fix error when clicking twice on the stop button when stopping a container
    from the admin interface (#527)
  • Fix issue included in 2.0.0 with hard-coded username for server requests
    (#534)

• Refactor:

  • Put all the Javascript and CSS dependencies in two bundles (#510)
  • Clear the selenium tests code so that it is now easier to write new tests
    (#515)
  • Remove Bower from the dependencies and use only NPM for package management
    (#517)
  • Remove Jinja and use Tornado templates (#521)

• Other:

  • Fix TRAVIS build which was failing because of an update of the docker
    version (#529)

SimPhoNy Remote 2.0.1

• Fixes:

  • Fix issue with hard-coded username for server requests (#535)

• Other:

  • Fix TRAVIS build which was failing because of an update of the docker
    version (#536)

Simphony Remote 2.0.0

What's new in SimPhoNy Remote 2.0.0

• Switch to Vue for both admin interface and user interface (#400, #402, #405,
  #407, #410, #411, #412, #413, #414, #420, #422, #423, #428, #431, #433, #434,
  #436, #437, #438, #440, #442, #443, #446, #447, #448, #450, #451, #456, #459,
  #465, #467, #468, #471, #472, #473, #480, #481, #482, #489)

• Added search. Now only applications matching will be shown (#417, #427)

• Added share button to extract the URL of the container (#469)

• First application is now automatically selected (#418)

• Adapted backend for new Vue based interface:

  • Usage of new tornado-webapi interface (#403)
  • Added REST resource for statistics, needed by #395 (#406)
  • Server side admin support for new Admin interface (#425)

• Renamed some entities to more appropriate names (#419)

  • The term Accounting now refers exclusively to the relationship table
    connecting users, applications and policies.
  • The config file accounting_class and accounting_kwargs are now
    database_class and database_kwargs.
  • AppAccounting is now ORMDatabase. Similarly, CSVAccounting is now
    CSVDatabase.
  • The above two break compatibility with the old configuration files.
    Old configuration files must be changed both in the options
    and the class they refer to.
  • Added alembic file to support the migration (#445)

• Removed CDN usage for full intranetwork compatibility.

• Upgraded configurable-http-proxy to 2.0.1 (#394)

• Added statistics in the main (Home) Admin panel. (#395)

• Pinned against pre-release version of Jupyterhub due to deprecation and
  incompatibility with authenticators (#396)

• Extracted application name in the topbar (#462)

• Fixes:

  • Compatibility with some adblockers for google analytics (#379)
  • Added random token to container name to prevent conflict during stop
    of containers (#381)
  • Documented behavior with uppercase-lowercase names with github
    authentication. (#386)
  • Performs re-registration of container when the jupyterhub service is
    stopped, to regain access to containers (#387)
  • Example jupyterhub configuration file allows now to work with no external
    interfaces (#409)
  • Using node 6 for the builds and prevent the use of node 4 from travis to
    workaround disrupting ECONNRESET issues (#488)
  • Upgraded astor to master to fix python 3.5 incompatibility during
    documentation build (#494)
  • Skip containers that are not found while checking container.items (#478)

• Refactor:

  • Virtual docker has been cleaned up completely (#389)
  • Container manager deprecated find methods have been removed in favor
    of a different interface. (#391)
  • Use webpack to include javascript code (#452, #458)
  • Use of ES6 for the main development (#457)
  • Changed frontend file layout (#454, #460)
  • Removed underscore and moment from the javascript dependencies (#455)
  • Replaced jshint with eslint (#463)

• Other:

  • Made tests less verbose with logging (#408)
  • Reduced verbosity at build (#424)

Simphony-Remote v1.1.0

• Use container provenance information to prevent access to unrelated
  containers or simphony-remote instances (#361)
• Upgraded tornado WebAPI to 0.5.0 (#335, #365, #340)
• Interface overhaul. Introduced Admin-LTE frontend (#346)
• Upgraded against jupyterhub 0.8.0.dev0 (#355, #358)
• Introduced "realms" to hold container provenance in case of shared docker
  server (#361)
• Added dynamic whitelist for GitHub login (#351, #359, #364)
• Fixes:
  • forever stuck spinner in case of docker internal failure (#336)
  • Documented unexpected behavior reported in #305: containers not visible
    if the per-user server is already running (#342)
  • Incorrect username in admin panel has been fixed (#353)
  • Removed selenium_test from deployment (#356)
  • Establish correct keyboard focus when canvas is made visible (#362)
• Refactor:
  • Extracted macro in jinja template to a separate file (#337)
  • Cleaned up javascript utils module into separate files (#339)
  • Use of table macro to reduce template duplication (#341)
  • Use setup.py to generate the version.py file (#357)
  • Made async docker client instance in ContainerManager private (#360)
• Other:
  • Fixed changes in ubuntu dependency builds (#352)
  • Added some basic example configuration files (#363)

Simphony remote v1.0.0

Stable version 1.0, feature complete and stable.

Identical to v.0.9.0 in all respects, with the exception of minor documentation fixes.

Version 1.0 branch master-v1 is where this tag resides, and it is dedicated for continuing v1 development.

Simphony remote 0.9.0

Merge pull request #333 from simphony/v0.9.0

Release v0.9.0

Simphony remote docker manager v0.8.0

Summary

• Introduced Google Analytics support for start of Applications (#274).
• Support for passing configurable data at application startup (#255, #257, #260, #263, #264, #266)
  Documentation of the resulting docker image protocol (#278)
• Virtual user workspace is now created once and preserved, with a identifiable name (#270)
• Launching or viewing application now opens a new window (#269)
• Makefile rule and documentation for docker upgrade on Ubuntu 14.04 host (#249)
• Introduced npm/bower package management. Removed now irrelevant files. (#272, #273, #275)
• UI:
  • Added spinner during loading of applications. Added message in case of no applications available (#252)
  • beautification (#265)
• CI:
  • Removed Paraview image retrieval (#256)
  • Better Travis output using before_script to perform devdeps installation. (#267)
  • Added test coverage for JavaScript code with Blanket (#276)
• Refactor:
  • Major overhaul of JavaScript layer (#250)
  • Finalized porting of WebAPI to tornadowebapi (#254)
• Fix:
  • Reporting error in case of double start/stop request, removing a potential race condition (#279)
  • Documented command line start request behavior for already started container (#280)

Simphony remote docker manager v0.7.0

Changes

• Addressed issues for general support for Docker containers holding Web applications
  (jupyter notebook, filemanager) available as simphony-remote-docker 0.3.0.
• REST+ajax based retrieval of available applications (#209, #214)
• Show application policy information in application list (#242)
• Preparation for REST framework extraction:
  • factored out authenticator code from the BaseHandler (#215)
  • soft deprecation of subpackage (#236)
• Upgraded dependencies to jupyterhub 0.7.0.dev0 (#217), configurable-http-proxy (#219)
  to fix forwarding bugs in jupyterhub.
• Pinned request package dependency to 2.10.0 due to dockerpy constraints (#222)
• Renamed Spawner to SystemUserSpawner (#205)
• Added linting and testing infrastructure for javascript (#200)
• Documentation fixes and refactorings:
  • General fixes (#179, #198, #199, #202, #232, #233)
  • Use of autosummary for API extraction (#194, #234)
  • Extracted traitlets documenter in a separate repository (#210)
• Migrated tests under the appropriate paths in the package tree (#196)
• Command remoteapprest prints out only essential (UI name) application information,
  instead of the whole content of the request. (#230)
• Removed the need for sudo in configurable-http-proxy installation (#244). Installation is now local.
• Support for Ubuntu 16.04 (#243)
  • Pinned dockerpy package dependency to 1.8.1
  • Update deployment docs for Ubuntu 16.04
• Fix: Failing selenium tests due to unexpected client-side selenium behavior (#203)
• Fix: Added missing jupyterhub_config.py from MANIFEST.in (#206), fixed other paths (#207)
• Fix: Exclude applications in the REST item list when not available (#225)
• Fix: Handle failure of ajax retrieval so that partial failure is tolerated (#223)
• Refactor: removed start/stop_spawner (#208)
• Refactor: cleaned up docker label namespacing (#212)

Simphony remote docker manager v0.6.0

What's new in SimPhoNy Remote 0.6.0

Summary

• Added error payload to REST api (#186)
• Use dummy and virtual objects for testing (#172)
• Fix remoteappmanager config file consistency with docker-py (#171)
• Config file is made optional for remoteappmanager (#170)
• Add license in documentation (#169)
• Add REST Javascript client (#165)
• Add traitlets documenter for documentation (#163)
• Add troubleshoot page in documentation (#160)
• Bug fix: Timeout issue in tests (#167)
• Bug fix: Make sure remoteappdb closes the session on exit
• Bug fix: Source distribution with requirement files (#155)