NOTICE: This repository has been archived and development moved to gohypergiant/charts
Deploy and manage Jupyterlab and Hyperdrive Community Edition locally, on AWS, or to any Kubernetes cluster
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
- Install prerequisites.
- Clone the repo
git clone https://github.com/gohypergiant/firefly.git
- Run the build script
build.sh
- The stack takes approximately 2 minutes to install. After that, navigate to
http://localhost:8090/to access Firefly.
-
Install prerequisites.
-
Add the helm repo
helm repo add firefly https://gohypergiant.github.io/firefly
-
Install the helm chart with
helm install firefly firefly/firefly. Be sure to include your customized values file. -
The stack takes approximately 2 minutes to install. After that, navigate to
http://localhost:8090/or the ingress host specified in your values file to access Firefly.
- An AWS account
- A route53 zone
- An SSH keypair added to AWS
- An IAM user with permissions to deploy and configure EC2 instances and DNS via Cloudformation
See the user manual for instructions
Firefly/Hyperdrive Notebooks is designed to make the already amazing Zero2Jupyterhub even easier to launch and manage while providing enhancements via the Community Edition of Hyperdrive. It can be deployed locally, onto an existing Kubernetes cluster, or via Cloudformation on AWS.
After launching your deployment, navigate to the signup page to create the first user, named firefly
firefly is the default admin and first authorized user, but does not have a password until the user is registered for the first time. This allows you to set your own password when the stack is launched for the first time. Your password must be 10 characters or longer.
After registering the first user, you can now log in and authorize or manage additional users
Or you can administer the Hub itself as an admin user
- GPU support
- Hyperdrive Community Edition
- Additional profiles
- RBAC
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the Apache-2 License. See LICENSE for more information.