otty / dotfiles

All tools/Jupyter

Jupyter

jupyter

Free software, open standards, and web services for interactive computing across all programming languages.

Detected by jupyter, jupyter-lab, jupyter-notebook | macOS, Linux, Windows |jupyter.org

Sync it jupyter.toml

Sync rules

What travels, what stays, what never leaves

Synced1 path, copied whole to your other machines

~/.jupyter/directory

Secret fieldsInside a file that otherwise syncs

~/.jupyter/jupyter_server_config.jsonjson fields at

ServerApp.password

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Secret fieldsInside a file that otherwise syncs

~/.jupyter/jupyter_notebook_config.jsonjson fields at

NotebookApp.password

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Secret fieldsInside a file that otherwise syncs

~/.jupyter/jupyter_server_config.pylines starting with

c.ServerApp.password

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Secret fieldsInside a file that otherwise syncs

~/.jupyter/jupyter_notebook_config.pylines starting with

c.NotebookApp.password

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Stays on this machineInside a file that otherwise syncs

~/.jupyter/jupyter_server_config.pylines starting with c.ServerApp.root_dir

…

c.ServerApp.ip = "127.0.0.1"

c.ServerApp.port = 8888

c.ServerApp.open_browser = False

c.ServerApp.root_dir = "/Users/octocat/notebooks"machine-local

c.ServerApp.password = "argon2:$argon2id$v=19$m=10240,t=10,p=8$FAKEsaltFAKEsaltFAKEsa$FAKEhashFAKEhashFAKEhashFAKEhashFAKEhash"

c.ServerApp.allow_password_change = False

…

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Stays on this machineInside a file that otherwise syncs

~/.jupyter/jupyter_notebook_config.pylines starting with c.NotebookApp.notebook_dir

…

c.NotebookApp.ip = "127.0.0.1"

c.NotebookApp.port = 8888

c.NotebookApp.open_browser = False

c.NotebookApp.notebook_dir = "/Users/octocat/notebooks"machine-local

c.NotebookApp.password = "sha1:FAKEsalt0000:FAKEhash00000000000000000000000000000000"

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Excluded1 path, state rather than configuration — never uploaded

~/.jupyter/lab/workspaces/directory

Not a subtraction from the paths above: this is everything else Jupyter writes in your home directory that is state, not configuration. It keeps a whole-home manager like chezmoi from sweeping those up, and it still holds if the synced paths are ever widened.

Jupyter in your home directory Every rule on this page, by file

· lab/workspaces/ Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/jupyter.tomlThe file this page is generated from

id = "jupyter"

name = "Jupyter"

homepage = "https://jupyter.org"

description = "Free software, open standards, and web services for interactive computing across all programming languages."

icon = "SimpleIcons:jupyter"

detect = ["jupyter", "jupyter-lab", "jupyter-notebook"]

# https://docs.jupyter.org/en/latest/use/jupyter-directories.html — the config

# directory is JUPYTER_CONFIG_DIR, "~/.jupyter" by default on Linux, macOS and

# Windows alike. It holds jupyter_server_config.py/.json, the older

# jupyter_notebook_config.py/.json, and JupyterLab's user settings

# (https://jupyterlab.readthedocs.io/en/stable/user/directories.html:

# "$HOME/.jupyter/lab/user-settings/").

# The data and runtime directories are elsewhere and are not config:

# ~/.local/share/jupyter, ~/Library/Application Support/Jupyter and

# %APPDATA%/jupyter hold installed kernels and files of running servers.

paths = ["~/.jupyter/"]

# Same JupyterLab page: the workspaces directory keeps "the files that are

# currently open, the layout of the application areas and tabs" — session state

# the app rewrites as the user drags panels around.

exclude = ["~/.jupyter/lab/workspaces/"]

# No whole file here is a credential: the config files are mostly server

# options, and only the password hash comes out of them.

secret = []

# `jupyter server password` writes the hash into jupyter_server_config.json;

# the notebook-era command wrote it into jupyter_notebook_config.json under the

# name that release used (notebook/auth/security.py:

# config.NotebookApp.password = hashed_password). Both shapes are listed

# because a machine can still be carrying the old file.

[[secret_paths]]

file = "~/.jupyter/jupyter_server_config.json"

match = { key_path = ["ServerApp.password"] }

[[secret_paths]]

file = "~/.jupyter/jupyter_notebook_config.json"

match = { key_path = ["NotebookApp.password"] }

# The same hash, when the user sets it by hand in the Python config instead of

# letting `jupyter server password` write the JSON.

[[secret_paths]]

file = "~/.jupyter/jupyter_server_config.py"

match = { prefix = ["c.ServerApp.password"] }

[[secret_paths]]

file = "~/.jupyter/jupyter_notebook_config.py"

match = { prefix = ["c.NotebookApp.password"] }

# The directory the server serves is an absolute path into this machine's disk;

# the notebook-era name for the same setting was notebook_dir. The user picked

# that directory and will want it back when rebuilding this machine, so it is

# kept as this device's own value rather than dropped or handed to another box.

[[machine_lines]]

file = "~/.jupyter/jupyter_server_config.py"

match = { prefix = ["c.ServerApp.root_dir"] }

scope = "backup"

[[machine_lines]]

file = "~/.jupyter/jupyter_notebook_config.py"

match = { prefix = ["c.NotebookApp.notebook_dir"] }

scope = "backup"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/jupyter. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits c.ServerApp.root_dir and c.NotebookApp.notebook_dir for you — that part is Otty’s own sync, or a template you write by hand.