Min RK
acdd9bb674
Merge pull request #2203 from minrk/entrypoints
...
allow spawners and authenticators to register via entry points
2018-10-01 17:22:11 +02:00
Min RK
c02ab23b3d
allow spawners and authenticators to register via entrypoints
...
jupyterhub.authenticators for authenticators, jupyterhub.spawners for spawners
This has the effect that authenticators and spawners can be selected by name instead of full import string (e.g. 'github' or 'dummy' or 'kubernetes')
and, perhaps more importantly, the autogenerated configuration file will include a section for each installed and registered class.
2018-09-28 10:08:10 +02:00
Kyla Harper
a78655c5a7
Add DummyAuthenticator documentation
2018-09-27 11:42:06 -05:00
yuvipanda
358b830747
Expand & consolidate upgrade documentation
...
- Expands the previous documentation on upgrading JupyterHub
to include more information.
- Remove specific documentation on 0.7 -> 0.8 upgrade, since
this seems to be a straight copy of the markdown version of
upgrading docs. The important thing about the 0.7 -> 0.8 upgrade
(requiring versions of JupyterHub to match) is now in the
main document.
- Move from markdown to rst
2018-09-26 23:53:51 -07:00
yuvipanda
7c273296c2
Use python3 -m pip explicitly in docs
...
- Add a documentation convention listing this too.
Fixes #2191
2018-09-26 12:14:43 -07:00
yuvipanda
07b590e2c3
Link additional authenticators to wiki
...
The current list in the docs is out of date. The list
in the wiki is more up-to-date, and easier for folks
to change over time. In the long run, we should decide
where lists like this belong.
2018-09-20 22:49:00 -07:00
Matthias Bussonnier
077d8dec9a
Fix some typos using codespell.
...
And checking each manually. It's funny because one of the words in the
sphinx custom dictionary was wrong :-)
2018-08-29 21:24:28 -07:00
Kenan Erdogan
71cb628563
fix links in services doc
2018-08-06 11:11:14 +02:00
Matthias Bussonnier
a1c2a50810
Switch protocols to https in docs links
...
Chrome will start to show insecure website for http next week
2018-07-22 18:58:22 -07:00
Alex Marandon
678afd3783
Fix a couple of typos
2018-07-03 11:16:55 +02:00
Min RK
30f19cfc8c
mention get_env and get_args in spawner reference
...
these are important and usually required (especially get_env) for custom Spawner implementations
2018-06-29 14:46:08 +02:00
Carol Willing
37f4c4429e
edit and reflow user environment reference
2018-06-12 08:47:22 -07:00
Carol Willing
293410ec94
Merge pull request #1967 from minrk/config-docs
...
docs: configuring user environments
2018-06-12 07:55:53 -07:00
Min RK
ed6ee27dcd
docs: configuring user environments
...
covers system-wide installation, kernelspec registration, and the differences between containers and host systems
2018-06-12 14:34:26 +02:00
Min RK
aa9676ec5e
Merge pull request #1913 from rkdarst/announcement_text
...
Add customizable announcement text on home,login,logout,spawn
2018-06-12 14:14:21 +02:00
Min RK
5e93c7de4c
announcement doc language
...
per willingc review
2018-06-12 13:48:42 +02:00
Carol Willing
1b7965092e
remove backticks and long for rst format
2018-06-08 14:21:31 -07:00
Carol Willing
ef60be5a99
put backticks outside of link
2018-06-08 14:19:43 -07:00
Carol Willing
f78d652cd6
fix missing brackets
2018-06-08 14:18:14 -07:00
Carol Willing
3650575797
add a small section for pre/post spawn hooks
2018-06-08 14:13:45 -07:00
Tim Head
0f000f6d41
Merge pull request #1961 from willingc/doc-shib
...
Add link to authenticators used with Shibboleth
2018-06-08 18:17:08 +02:00
Chico Venancio
91a67bf580
database docs: fix formatting
2018-06-08 13:09:09 -03:00
Chico Venancio
c75eddb730
database docs utfmb4 collation and some versions of mysql/mariadb
2018-06-08 12:55:02 -03:00
Carol Willing
0f5888ad6c
Add link to authenticators used with Shibboleth
2018-06-08 08:22:11 -07:00
Carol Willing
6e7e18bc3c
add @minrk review comments
2018-06-08 07:34:09 -07:00
Carol Willing
19ecbf3734
add note about why no sqlite and nfs
2018-06-08 06:06:15 -07:00
Carol Willing
eac3e8ba90
add database doc section and edits to upgrading db
2018-06-08 05:51:00 -07:00
Min RK
ead13c6a11
further clarify that we are creating a new file, not editing nginx.confg
2018-06-06 12:00:21 +02:00
Min RK
ec9b244990
note where nginx config files are typically created.
2018-06-04 11:10:21 +02:00
Richard Darst
9c27095744
Add customizable announcement text on home,login,logout,spawn
...
- Using the new template_vars setting (#1872 ), allow the variable
`announcement` to create a header message on all the pages in the
title, or the variables `announcement_{home,login,logout,spawn}` to
set variables on these single pages.
- This is not the most powerful method of putting an announcement into
the templates, because it requires a server restart to change. But
the invasiveness is very low, and allows minimal message
without having to touch the templates themselves.
- Closes : #1836
2018-06-03 01:18:48 +03:00
Carol Willing
da095170bf
remove toctree item
2018-05-07 20:38:15 -07:00
Carol Willing
fc8e04b62f
reflow templates file
2018-05-07 20:29:13 -07:00
Carol Willing
9b0219a2d8
break up configuration examples
2018-05-07 20:18:02 -07:00
Carol Willing
6e212fa476
reflow proxy doc
2018-05-07 20:17:14 -07:00
Carol Willing
58f9237b12
refactor sudo example config
2018-05-07 15:38:16 -07:00
Eric Charles
0ed88f212b
add sudo.md
2018-05-07 19:49:26 +02:00
Eric Charles
a8c1cab5fe
add sudo doc
2018-05-07 19:49:26 +02:00
Erik Sundell
cf665517dd
links in docs corrected
2018-04-08 09:10:09 +02:00
Carol Willing
344a3e7b24
Add a spawner_class option to the reference example
2018-03-19 14:23:14 -07:00
Min RK
9640364713
Merge pull request #1665 from thedataincubator/templates-doc
...
Add documentation for new templates system
2018-02-22 15:03:10 +01:00
Robert Schroll
3ac4f48f82
Add version information to templates doc
2018-02-21 15:13:47 -08:00
Robert Schroll
c1dcdf49e5
Add doc page on templates
2018-02-15 16:18:15 -08:00
BerserkerTroll
312252b670
Fix Authentication state documentation
...
This — is how it actually works!
2018-01-17 05:45:47 +03:00
Carol Willing
e4e2b627fe
add formatting to clarify spawners' limits
2017-12-18 04:43:26 -08:00
Carol Willing
1e4f871bcc
update documentation on resource limits
2017-12-18 04:33:01 -08:00
Min RK
5d7e008055
Merge pull request #1512 from DeepHorizons/update-service-doc
...
Update docs and examples for the slash at the end of the prefix
2017-11-03 10:31:46 +01:00
Joshua Milas
3c5eb934bf
Update docs and examples for the slash at the end of the prefix
2017-10-31 14:04:37 -04:00
Joshua Milas
82e15df6e9
Added that you can also access the notebook if you are the owner
2017-10-31 10:15:02 -04:00
Joshua Milas
126c73002e
Updated the rest docs to about change in 0.8
...
In 0.8, the jupyterhub api token can also be used to make requests to
hte jupyter notebook given some conditions. This commit updates that
documentation
2017-10-21 09:18:08 -04:00
Min RK
04578e329c
typo in auth_state structure
...
it's 'name' not 'username'
2017-10-04 14:18:14 +02:00
