Skip to content

Commit 5e1389e

Browse files
authored
Update ZenML Spaces docs (#1098)
ZenML recently changed some things about how the dashboard issues / handles cookies and so currently the dashboard doesn't work from within the Huggingface website wrapper (only via the direct URL). I've amended the documentation to reflect this and to guide people in how to get it working.
1 parent 641dea0 commit 5e1389e

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/hub/spaces-sdks-docker-zenml.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,26 @@ After creating your Space, you'll notice a 'Building' status along with logs
6161
displayed on the screen. When this switches to 'Running', your Space is ready for use. If the
6262
ZenML login UI isn't visible, try refreshing the page.
6363

64-
Use our default login to access the dashboard (username: 'default', password:
65-
(leave it empty)).
64+
In the upper-right hand corner of your space you'll see a button with three dots
65+
which, when you click on it, will offer you a menu option to "Embed this Space".
66+
(See [the HuggingFace
67+
documentation](https://huggingface.co/docs/hub/spaces-embed) for more details on
68+
this feature.) Copy the "Direct URL" shown in the box that you can now see on
69+
the screen. This should look something like this:
70+
`https://<YOUR_USERNAME>-<SPACE_NAME>.hf.space`. Open that URL and use our default
71+
login to access the dashboard (username: 'default', password: (leave it empty)).
6672

6773
## Connecting to your ZenML Server from your Local Machine
6874

6975
Once you have your ZenML server up and running, you can connect to it from your
70-
local machine. To do this, you'll need to get your Space's URL.
76+
local machine. To do this, you'll need to get your Space's 'Direct URL' (see above).
7177

7278
<Tip warning={true}>
7379
Your Space's URL will only be available and usable for connecting from your
7480
local machine if the visibility of the space is set to 'Public'.
7581
</Tip>
7682

77-
In the upper-right hand corner of your space you'll see a button with three dots
78-
which, when you click on it, will offer you a menu option to "Embed this Space".
79-
(See [the HuggingFace
80-
documentation](https://huggingface.co/docs/hub/spaces-embed) for more details on
81-
this feature.) Copy the "Direct URL" shown in the box that you can now see on
82-
the screen. This should look something like this:
83-
`https://<YOUR_USERNAME>-<SPACE_NAME>.hf.space`.
84-
85-
You can now use this URL to connect to your ZenML server from your local machine
83+
You can use the 'Direct URL' to connect to your ZenML server from your local machine
8684
with the following CLI command (after installing ZenML, and using your custom
8785
URL instead of the placeholder):
8886

@@ -93,6 +91,13 @@ zenml connect --url '<YOUR_HF_SPACES_DIRECT_URL>' --username='default' --passwor
9391
You can also use the Direct URL in your browser to use the ZenML dashboard as a
9492
fullscreen application (i.e. without the HuggingFace Spaces wrapper around it).
9593

94+
<Tip warning={true}>
95+
The ZenML dashboard will currently not work when viewed from within the Huggingface
96+
webpage (i.e. wrapped in the main `https://huggingface.co/...` website). This is on
97+
account of a limitation in how cookies are handled between ZenML and Huggingface.
98+
You **must** view the dashboard from the 'Direct URL' (see above).
99+
</Tip>
100+
96101
## Extra Configuration Options
97102

98103
By default the ZenML application will be configured to use a SQLite
@@ -135,7 +140,6 @@ navigate to the Settings page by clicking the button in the upper right hand
135140
corner of the Dashboard and then click 'Update Password'.
136141
</Tip>
137142

138-
139143
## Upgrading your ZenML Server on HF Spaces
140144

141145
The default space will use the latest version of ZenML automatically. If you

0 commit comments

Comments
 (0)