Commit Graph

186 Commits

Author SHA1 Message Date
Min RK
225ace636a call client-allowed scopes JUPYTERHUB_OAUTH_CLIENT_ALLOWED_SCOPES 2022-07-08 10:18:59 -07:00
Min RK
62b38934e5 store scopes on oauth clients, too
rather than roles, matching tokens

because oauth clients are mostly involved with issuing tokens,
they don't have roles themselves (their owners do).

This deprecates the `oauth_roles` config on Spawners and Services, in favor of `oauth_allowed_scopes`.

The ambiguously named `oauth_scopes` is renamed to `oauth_access_scopes`.
2022-06-08 12:26:48 +02:00
YuviPanda
3264463366 Document the 'display' attribute of services
Ref https://github.com/2i2c-org/infrastructure/issues/1301
2022-05-11 19:04:58 +05:30
Björn Braunschweig
a0b9a1fe86 remove apache NE flag as it prevents opening folders and renaming files with whitespace characters. apache returns Bad Request 2022-05-09 11:36:14 +02:00
Erik Sundell
672e19a22a Merge pull request #3815 from minrk/changelog-2.2
Changelog for 2.2
2022-03-07 14:32:56 +01:00
Simon Li
4a1842bf8a Merge pull request #3809 from minrk/page_config_hook
Add user token to JupyterLab PageConfig
2022-03-04 21:27:34 +00:00
Min RK
8f18303e50 fix some links revealed by myst
mostly pre-myst markdown links
2022-03-04 10:41:20 +01:00
Min RK
bcad6e287d Merge pull request #3812 from ktaletsk/patch-1
Update example to not reference an undefined scope
2022-03-04 10:03:53 +01:00
pre-commit-ci[bot]
99cb1f17f0 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-03-03 15:41:17 +00:00
Richard Zowalla
10d5157e95 Apache2 Documentation: Updates Reverse Proxy Configuration (TLS/SSL, Protocols, Headers) 2022-03-03 16:40:38 +01:00
Konstantin Taletskiy
2fc4f26832 Update example to not reference an undefined scope
Fixes #3811
2022-03-01 12:25:54 -08:00
Min RK
9c498aa5d4 Document HubOAuth.get_token for requests on behalf of users 2022-03-01 10:05:17 +01:00
Simon Li
b1ffd4b10b Apache: set X-Forwarded-Proto header 2022-02-28 21:46:53 +00:00
Thorin Tabor
55f0579dcc idle-culler example config missing closing bracket 2022-02-22 13:16:37 -08:00
Min RK
88be7a9967 test coverage for Authenticator.managed_groups
- tests
- docs
- ensure all group APIs are rejected when auth is in control
- use 'groups' field in return value of authenticate/refresh_user, instead of defining new method
- log group changes in sync_groups
2022-01-24 13:45:35 +01:00
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