Commit Graph

171 Commits

Author SHA1 Message Date
Thijs Walcarius
5466224988 Improve documentation about spawner error messages 2022-01-18 09:18:01 +01:00
Min RK
db3b2d8961 refine service auth docs
favor HubOAuth, as that should really be the default for most services

- Remove some outdated 'new in' text
- Remove docs for some deprecated features (hub_users, hub_groups)
- more detail on what's required
2021-11-30 10:48:53 +01:00
Min RK
202b2590e9 doc: remove redundant TOC from services doc
The same TOC is automatically generated on the sidebar, no need for a manual copy
2021-11-30 09:18:57 +01:00
Min RK
2dc2c99b4a Merge pull request #3640 from minrk/doc-api-only
add api-only doc
2021-11-25 20:26:25 +01:00
pre-commit-ci[bot]
e703555888 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2021-11-25 19:16:41 +00:00
Min RK
7e102f0511 Apply suggestions from code review
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2021-11-25 20:16:10 +01:00
Min RK
8813bb63d4 update to openapi 3.0
easier to implement oneOf schemas

document scopes, session_id in /api/user model
2021-11-17 09:44:38 +01:00
Min RK
88f31c29bb add api-only doc
Describe how to use JupyterHub as a "behind the scenes" implementation detail,
rather than a user-facing application.
2021-11-04 17:16:59 +01:00
Min RK
468aa5e93c render openapi spec client-side
- move spec to _static/rest-api.yml, since the original yaml must be served
- copy javascript rendering code from FastAPI (uses swagger-ui)
- remove link to pet store, since there isn't a big enough difference to duplicate it
- remove bootprint rendering with node
2021-10-29 13:13:41 +02:00
Edgar Costa
725fa3a48a typo 2021-10-19 22:39:41 -04:00
Min RK
17f811d0b4 add latest changes to 2.0 changelog
- nullauthenticator
- lab by default
2021-09-28 15:28:59 +02:00
Min RK
4082006039 2.0: jupyterlab by default
swaps from default nbclassic and opt-in to lab, to now default to lab and opt-in to nbclassic

defaults to jupyterlab *if* lab 3.1 is available,
so should still work without configuration if lab is unavailable (or too old)
2021-09-23 14:52:14 +02:00
Min RK
12ab53fb37 changelog for 2.0
remove suggestions of `admin` permissions, in favor of roles and scopes
2021-09-13 13:44:32 +02:00
Min RK
857f7271ca email-typo 2021-09-03 14:32:24 +02:00
Min RK
a32986e9cc server-api doc: final touches 2021-08-06 10:55:43 +02:00
Min RK
4f6fa3ddf7 Apply suggestions from code review
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2021-08-04 14:11:17 +02:00
Min RK
b1b6a9e76c Add detailed doc for starting/stopping/waiting for servers via api
and complete implementation in examples/server-api
2021-08-04 12:49:12 +02:00
AbdealiJK
d5d05b8777 doc: Mention a list of known proxies available 2021-07-22 07:13:56 +05:30
IvanaH8
12ffc42114 Fix docstring indentation and reference to flask example in docs
example using flask for Implementing your own Auth with JupyterHub was not displayed
2021-06-18 11:07:33 +02:00
0mar
7a3b237bb3 Refactored scope names and updated docs to reflect this 2021-06-15 13:00:15 +02:00
Min RK
4a0fed1a5b address review in services doc 2021-06-08 09:35:45 +02:00
Min RK
40de16e0e1 Update service examples and documentation with access scopes and roles 2021-06-07 14:02:13 +02:00
Min RK
8eaed91f79 Merge pull request #3444 from minrk/oauth-details
Oauth details docs
2021-06-07 11:56:49 +00:00
Min RK
d39673eea2 Flesh out oauth details doc
adress review, add emoji, expand details, examlpes, and add discussion of caching and revocation.
2021-05-26 12:28:59 +02:00
Min RK
d2dc38d773 Sync with main 2021-05-21 12:53:37 +02:00
Min RK
5a9ca0c710 Merge pull request #3470 from kinow/patch-2
(docs) Fix DummyAuthenticator class reference
2021-05-21 12:01:26 +02:00
Min RK
05f47b14f3 Merge pull request #3381 from minrk/rm-redundant-args
Stop specifying `--ip` and `--port` on the command-line
2021-05-21 10:09:16 +02:00
Bruno P. Kinoshita
5a10107da8 (docs) Fix DummyAuthenticator class 2021-05-21 00:19:44 +12:00
Min RK
4e41a39b30 Sync with main 2021-05-12 16:08:03 +02:00
Min RK
915fa4bfcc Apply suggestions from code review
thanks Carol!

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2021-05-12 11:05:47 +02:00
Min RK
e7d249bb3d Sync with master 2021-05-11 10:52:46 +02:00
Min RK
63a61bcc2f prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working
2021-05-11 10:40:04 +02:00
Min RK
863b4c7d50 Deprecate and remove some old auth bits
- remove long-deprecated `POST /api/authorizations/token` for creating tokens
- deprecate but do not remove `GET /api/authorizations/token/:token` in favor of GET /api/user
- remove shared-cookie auth for services from HubAuth, rely on OAuth for browser-auth instead
- use `/hub/api/user` to resolve user instead of `/authorizations/token` which is now deprecated
2021-05-05 14:07:14 +02:00
Min RK
3602da550c more spawner docs for environment variables, cli args, ips and ports 2021-05-05 10:21:32 +02:00
Min RK
148257de12 DOC: details of oauth in jupyterhub 2021-04-23 14:12:46 +02:00
Nathan Barber
7bd660d899 Revert documentation updates on /groups/{name} 2021-04-21 10:05:50 -04:00
Nathan Barber
3c328385a4 Add default limit and max limit config vars 2021-04-16 13:11:57 -04:00
Nathan Barber
100111ed2c Add pagination info to docs 2021-04-15 17:37:57 -04:00
Min RK
9331dd13da run pre-commit (prettier) 2021-02-12 15:25:58 +01:00
Zsailer
f69ef9f846 add docs describing jupyter_server 2021-01-12 09:11:23 -08:00
sangarshanan
8ede924956 Remove extra paranthesis 2020-12-11 13:15:13 +05:30
sangarshanan
55c2d3648e Add the missing parenthesis in service.md 2020-12-11 01:53:35 +05:30
Geoffroy Youri Berret
6e161d0140 Fixed idle-culler references.
Merge request #3257 fixed #3256 only on getting-started/services-basics.md
There is still a reference to jupyterhub example cull-idle in reference/services.md
2020-12-04 09:28:02 +01:00
Min RK
73ac6207af Merge pull request #3244 from mhwasil/fix-https-redirect-issues
[Docs] Fix https reverse proxy redirect issues
2020-12-02 11:30:09 +01:00
Min RK
8b19413fa1 Merge pull request #3242 from consideRatio/pr/py36-async-await
Assume py36 and remove @gen.coroutine etc.
2020-11-20 09:31:43 +01:00
fyrzbavqr
097974d57d Update services.md
Fix small typo
2020-11-19 04:14:54 -08:00
Erik Sundell
e1166ec834 Replace @gen.coroutine/yield with async/await 2020-11-11 14:36:56 +01:00
Mohammad Wasil
9657430cac Fix reverse proxy redirect from https 2020-11-04 17:59:28 +01:00
Min RK
032ae29066 Merge pull request #3184 from rainwoodman/patch-1
Mention the PAM pitfall on fedora.
2020-10-02 10:50:17 +02:00
Yu Feng
21caa57e7b remove sshauthenticator reference. 2020-10-01 09:13:37 -07:00