josevalim commited on
Commit
4b91b40
1 Parent(s): 1bd5560

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -4
README.md CHANGED
@@ -8,14 +8,16 @@ fullWidth: true
8
  pinned: true
9
  ---
10
 
11
- You can install and run Livebook inside a Hugging Face Space. Here's how you can do it:
12
 
13
  1. Duplicate the Livebook Space to your account (by clicking on the [︙] in the top right and choosing "Duplicate this Space")
14
  2. Create a secret inside your new Space with the name `LIVEBOOK_PASSWORD` and set the secret value to a password of your choice with at least 12 characters
15
  3. (Optional) If you plan to use GPU Hardware, also set a secret named `XLA_TARGET` to `cuda118`
16
  4. Restart the Space
17
 
18
- Hugging Face will start Livebook inside your Space. Livebook will show you a login page, and you can use the value you set for the LIVEBOOK_PASSWORD Space secret.
19
 
20
- There's only one caveat about running Livebook inside a Hugging Face Space; the Space's visibility setting must be public. Otherwise, Smart Cells won't work.
21
- That said, your Livebook instance will still be behind Livebook authentication since you've set the LIVEBOOK_PASSWORD secret.
 
 
 
8
  pinned: true
9
  ---
10
 
11
+ You can install and run [Livebook](https://livebook.dev/) inside a Hugging Face Space. Here's how you can do it:
12
 
13
  1. Duplicate the Livebook Space to your account (by clicking on the [︙] in the top right and choosing "Duplicate this Space")
14
  2. Create a secret inside your new Space with the name `LIVEBOOK_PASSWORD` and set the secret value to a password of your choice with at least 12 characters
15
  3. (Optional) If you plan to use GPU Hardware, also set a secret named `XLA_TARGET` to `cuda118`
16
  4. Restart the Space
17
 
18
+ Hugging Face will start Livebook inside your Space. Livebook will show you a login page, and you can use the value you set for the `LIVEBOOK_PASSWORD` Space secret.
19
 
20
+ The following caveats apply to running Livebook inside a Hugging Face Space:
21
+
22
+ * The Space's visibility setting must be public. Otherwise, Smart Cells won't work. That said, your Livebook instance will still be behind Livebook authentication since you've set the `LIVEBOOK_PASSWORD` secret.
23
+ * Configuration and "Settings" done in Livebook will be lost once the instance restarts. Consider using [the desktop app](https://livebook.dev/) if you find yourself in need to persist configuration across deployments.