You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributer_guide/development.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -40,4 +40,4 @@ We use `black <https://github.com/psf/black>`_ to format our code.
40
40
Contributing
41
41
------------
42
42
43
-
If you want to contribute to ``ngshare``, submit a pull request to `https://github.com/lxylxy123456/ngshare/pulls <https://github.com/lxylxy123456/ngshare/pulls>`_.
43
+
If you want to contribute to ``ngshare``, submit a pull request to `https://github.com/LibreTexts/ngshare/pulls <https://github.com/LibreTexts/ngshare/pulls>`_.
If you find a bug in ``ngshare``, submit an issue to `https://github.com/lxylxy123456/ngshare/issues <https://github.com/lxylxy123456/ngshare/issues>`_.
4
+
If you find a bug in ``ngshare``, submit an issue to `https://github.com/LibreTexts/ngshare/issues <https://github.com/LibreTexts/ngshare/issues>`_.
Copy file name to clipboardExpand all lines: docs/user_guide/install_jupyterhub.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Intalling in a Regular JupyterHub Environment as a Managed Service
3
3
4
4
This guide assumes you already know how to set up a JupyterHub environment. You should also be familiar with `adding JupyterHub-managed services <https://jupyterhub.readthedocs.io/en/stable/reference/services.html#hub-managed-services>`_ into ``jupyterhub_config.py``.
5
5
6
-
If you prefer looking at examples instead, `here's <https://github.com/lxylxy123456/ngshare/tree/master/testing/install_jhmanaged>`_ a sample installation setup. It doesn't demonstrate all the configurable options, though.
6
+
If you prefer looking at examples instead, `here's <https://github.com/LibreTexts/ngshare/tree/master/testing/install_jhmanaged>`_ a sample installation setup. It doesn't demonstrate all the configurable options, though.
Copy file name to clipboardExpand all lines: docs/user_guide/install_z2jh.rst
+18-12Lines changed: 18 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Installing on a Z2JH Cluster
3
3
4
4
This guide assumes you already have a Kubernetes cluster with a persistent volume provisioner (which should be the case if you run Z2JH). You should also be familiar with installing Z2JH and using Helm.
5
5
6
-
If you prefer looking at examples instead, `here's <https://github.com/lxylxy123456/ngshare/tree/master/testing/install_z2jh>`_ a sample installation setup. It doesn't demonstrate all the configurable options, though.
6
+
If you prefer looking at examples instead, `here's <https://github.com/LibreTexts/ngshare/tree/master/testing/install_z2jh>`_ a sample installation setup. It doesn't demonstrate all the configurable options, though.
Afterwards, create a ``config.yaml`` file to customize your helm chart. Here's a bare minimum ``config.yaml`` file:
21
+
Afterwards, create a ``config.yaml`` file to customize your helm chart. Here's a bare minimum ``config.yaml`` file that assumes you're installing ``ngshare`` into the same namespace as Z2JH, and that you only need 1GB of storage in total:
22
22
23
23
.. code:: yaml
24
24
@@ -45,6 +45,9 @@ Here's a sample ``config.yaml`` file that contains the most commonly used option
If you didn't install Z2JH in the default namespace, it is recommended to install ``ngshare`` in the same namespace as Z2JH by specifying ``--namespace your_namespace_name`` in ``helm install``. Note that if you don't put ``ngshare`` and Z2JH in the same namespace, you will have to modify the ``ngshare.hub_api_url`` value in your config to point to ``http://hub.your-z2jh-namespace.svc.cluster.local:8081/hub/api`` instead (replace ``your-z2jh-namespace`` with the namespace where Z2JH is installed).
71
+
67
72
After installation, Helm should give you some instructions on how to configure Z2JH.
68
73
69
74
Configuring Z2JH to Work with ngshare
@@ -81,10 +86,10 @@ The ``ngshare`` Helm chart should output something like this at the end of insta
If you have installed ``ngshare`` in the same namespace as JupyterHub, then just add this to your Z2JH ``config.yaml``. Otherwise, you will have to change the URL and use the fully qualified domain name for the ``ngshare`` service (usually ``ngshare.my-namespace.svc.cluster-domain.example``). After you have updated Z2JH's configuration using ``helm upgrade``, you can verify the service is working as intended by logging into JupyterHub, clicking "Control Panel", then "Services -> ngshare". If you see the ``ngshare`` welcome page, you may proceed.
92
+
Follow the instructions and add the code block to your Z2JH ``config.yaml``. After you have updated Z2JH's configuration using ``helm upgrade``, you can verify the service is working as intended by logging into JupyterHub, clicking "Control Panel", then "Services -> ngshare". If you see the ``ngshare`` welcome page, you may proceed.
88
93
89
94
Installing ngshare_exchange
90
95
---------------------------
@@ -106,18 +111,19 @@ Afterwards, you may install ``ngshare_exchange``:
106
111
107
112
python3 -m pip install ngshare_exchange
108
113
109
-
Finally, you need to configure nbgrader to use ngshare_exchange. This can be done by adding the following to nbgrader's global config file, ``/etc/jupyter/nbgrader_config.py``:
114
+
Finally, you need to configure nbgrader to use ngshare_exchange. This can be done by adding some code to nbgrader's global config file, ``/etc/jupyter/nbgrader_config.py``. The relevant code should be output by the ``helm install`` command earlier when you installed ``ngshare``:
110
115
111
116
.. code:: python
112
117
113
118
from ngshare_exchange import configureExchange
114
119
c=get_config()
115
-
configureExchange(c)
116
-
117
-
# Add the following to let students access courses without configuration
# Add the following line to let students access courses without configuration
118
122
# For more information, read Notes for Instructors in the documentation
119
123
c.CourseDirectory.course_id ='*'
120
124
121
-
A sample singleuser Dockerfile that does all of the above is available `on Github <https://github.com/lxylxy123456/ngshare/tree/master/testing/install_z2jh/Dockerfile-singleuser>`_.
125
+
Depending on your helm values and the namespace you install in, the URL will be different. Be sure to follow the code your ``helm install`` command outputs.
126
+
127
+
A sample singleuser Dockerfile that does all of the above is available `on Github <https://github.com/LibreTexts/ngshare/tree/master/testing/install_z2jh/Dockerfile-singleuser>`_.
122
128
123
129
If running ``nbgrader list`` doesn't cause any significant errors, you have installed ``ngshare_exchange`` correctly. Please check `Notes for Administrators <notes_admin.html>`_ and `Notes for Instructors <notes_instructor.html>`_ for more information on how to use ``ngshare``. The students should be able to use nbgrader as normal without additional configuration.
Please note that if during your first installation you didn't specify an API token, the randomized API token will be regenerated every upgrade. Therefore, it's highly recommended to specify the API token in your config.yaml.
15
+
14
16
If you aren't using the helm chart and installed ngshare using pip, upgrade through pip:
0 commit comments