Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation about getting a LocalFileIdManager #39

Open
davidbrochart opened this issue Oct 28, 2022 · 2 comments
Open

Improve documentation about getting a LocalFileIdManager #39

davidbrochart opened this issue Oct 28, 2022 · 2 comments
Labels
question Further information is requested

Comments

@davidbrochart
Copy link
Contributor

The documentation says that "jupyter_server_fileid, by default, constructs a LocalFileIdManager instance and stores it under serverapp.settings["file_id_manager"]."
But it seems that the default manager is an ArbitraryFileIdManager and I don't see how to use a LocalFileIdManager.
Can you give an example of how to achieve that, maybe through configuration?

@davidbrochart davidbrochart added the question Further information is requested label Oct 28, 2022
@kevin-bates
Copy link
Member

Hi @davidbrochart. It looks like #37 didn't update the docs. You should be able to use the LocalFileIdManager via configuration...

$ jupyter lab --FileIdExtension.file_id_manager_class=jupyter_server_fileid.manager.LocalFileIdManager

[I 2022-10-28 07:23:08.576 FileIdExtension] Configured File ID manager: LocalFileIdManager
[I 2022-10-28 07:23:08.576 FileIdExtension] LocalFileIdManager : Configured root dir: /Users/kbates/notebooks
[I 2022-10-28 07:23:08.576 FileIdExtension] LocalFileIdManager : Configured database path: /Users/kbates/Library/Jupyter/file_id_manager.db
[I 2022-10-28 07:23:08.580 FileIdExtension] LocalFileIdManager : Successfully connected to database file.
[I 2022-10-28 07:23:08.580 FileIdExtension] LocalFileIdManager : Creating File ID tables and indices.
[I 2022-10-28 07:23:08.671 FileIdExtension] Attached event listeners.

@davidbrochart
Copy link
Contributor Author

Thanks Kevin, I just checked and it works fine.
Let's keep this issue open until the docs are updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants