Skip to content

Commit 0f9b4cc

Browse files
Update Community Cloud docs (#766)
* Community Cloud sign-up and account instructions Updated Get started page to better describe the accounts used with Streamlit Community Cloud and how to sign up. * Wording clarity * Delete duplicate images This commit duplicate images in public/images/streamlit-cloud that were an artifact of renaming the folder to .../streamlit-community-cloud * Update sign-in instructions and images Update sign-in instructions and images for consistency * Update sign-in-email-3.png fix: URL mask alignment * Update Community Cloud Get started * Update images & move GitHub connection details More image updates for consistency and better resolution. GitHub connection details moved to a separate page. * Updated Community Cloud re:default URL Updated Community Cloud documentation to mention there is a pre-filled custom subdomain and that it can be deleted or changed. * Updated custom subdomain images Updated custom subdomain images for consistency and resolution. * Update app-dependencies.md Improve explanation of `requirements.txt` and `packages.txt` * Prettify Python package managers table Make table of Python package managers prettier. * Remove Workspace analytics * Edits for clarity Small edits for clarity and from feedback * Move connecting to GitHub Move Connect to GitHub out of Community Cloud Get started and make a separate page. * Delete duplicate Connect GitHub Delete duplicate content from temporary rearrangement. * Remove duplicate Connect to data sources index Removed duplicate index of Connect to data sources tutorials. * Rearrange folder structure in Community Cloud Move "Deploy your app", "Share your app", and "Manage your app" to the top level of navigation within Community Cloud. Move Trust and Security to Getting started alongs side connecting to GitHub/GitHub authorization. * Update Get started/Connect GitHub Updated instructions to connect to GitHub. Included explanation on authorizing organizations. * Add Community Cloud Quickstart * Added GItHub account management Added instructions for connecting and modifying GitHub account permissions after account creation. * Update links Update links from file rearrangement * Update Streamlit Community Cloud index.md Rearrange tiles on top-level page for Streamlit Community Cloud. * Split Get started in Community Cloud Move account creation and workspace exploration to their own sub-pages under Get started. * Update Community Cloud Quickstart Change to using the built-in sample app deployment from the New App menu instead of manually forking an example app to deploy. * Update account creation in Get started Additional images and edits to document the process of creating a Streamlit Community Cloud account. * Link updates and clarity edits Link updates and clarity edits within the pages of Get started in Community Cloud. * Edit for enterprise language Revise language in security-model.md * Update secrets management in Community Cloud * Update Share your app Move Manage your app to before Share your app. Update Share your app page including updating and adding images. * Update Embed your app * Update indexability.md * Update share-previews.md * Create app-analytics.md Modify description of app analytics and create separate page for it. Update and add images. * Create favorite-your-app.md Create separate page for app favoriting. Update and add images. * Create reboot-your-app.md Create separate page for rebooting apps. Update and add images. * Create delete-you-app.md Create separate page for deleting apps. Update and add images. * Update index.md for Manage your app Rearrange content to summarize the different places to access menus. Summarize each menu with links to the associated detail pages. Update and add images. * Create workspace-settings.md Create separate page for workspace settings as distinct from app settings. Update and add images. * Update links, images, and image descriptions Verify and update links and images from Get started through Manage your app/Workspace settings. * Update links, images, and image descriptions (Share your app) Verify and update links and images within Share your app section. * Remove localhost from link * Update links, images, and image descriptions (Manage your account section) Verify and update links and images within Manage your account section. * Small fixes and typos * Update main, Community Cloud page Change summary navigation at the top level of Streamlit Community Cloud. * Update links to Community Cloud section * Update header links to Streamlit Community Cloud section * Update redirects for Community Cloud
1 parent 3c9087c commit 0f9b4cc

File tree

277 files changed

+1888
-1579
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

277 files changed

+1888
-1579
lines changed

content/kb/dependencies/install-package-pypi-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: /knowledge-base/dependencies/install-package-not-pypi-conda-available-gith
77

88
## Overview
99

10-
Are you trying to deploy your app to [Streamlit Community Cloud](/streamlit-community-cloud), but don't know how to specify a [Python dependency](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies#add-python-dependencies) in your requirements file that is available on a public GitHub repo but not any package index like PyPI or Conda? If so, continue reading to find out how!
10+
Are you trying to deploy your app to [Streamlit Community Cloud](/streamlit-community-cloud), but don't know how to specify a [Python dependency](/streamlit-community-cloud/deploy-your-app/app-dependencies#add-python-dependencies) in your requirements file that is available on a public GitHub repo but not any package index like PyPI or Conda? If so, continue reading to find out how!
1111

1212
Let's suppose you want to install `SomePackage` and its Python dependencies from GitHub, a hosting service for the popular version control system (VCS) Git. And suppose `SomePackage` is found at the the following URL: `https://github.com/SomePackage.git`.
1313

content/kb/dependencies/libgl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you use OpenCV in your app, include `opencv-python-headless` in your requirem
1515

1616
If `opencv-python` is a _required_ (non-optional) dependency of your app or a dependency of a library used in your app, the above solution is not applicable. Instead, you can use the following solution:
1717

18-
Create a `packages.txt` file in your repo with the following line to install the [apt-get dependency](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies#apt-get-dependencies) `libgl`:
18+
Create a `packages.txt` file in your repo with the following line to install the [apt-get dependency](/streamlit-community-cloud/deploy-your-app/app-dependencies#apt-get-dependencies) `libgl`:
1919

2020
```
2121
libgl1

content/kb/dependencies/module-not-found-error.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You receive the error `ModuleNotFoundError: No module named` when you deploy an
1111

1212
## Solution
1313

14-
This error occurs when you import a module on Streamlit Community Cloud that isn’t included in your requirements file. Any external [Python dependencies](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies#add-python-dependencies) that are not distributed with a [standard Python installation](https://docs.python.org/3/py-modindex.html) should be included in your requirements file.
14+
This error occurs when you import a module on Streamlit Community Cloud that isn’t included in your requirements file. Any external [Python dependencies](/streamlit-community-cloud/deploy-your-app/app-dependencies#add-python-dependencies) that are not distributed with a [standard Python installation](https://docs.python.org/3/py-modindex.html) should be included in your requirements file.
1515

1616
E.g. You will see `ModuleNotFoundError: No module named 'sklearn'` if you don’t include `scikit-learn` in your requirements file and `import sklearn` in your app.
1717

content/kb/dependencies/no-matching-distribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You receive the error `ERROR: No matching distribution found for` when you deplo
1111

1212
## Solution
1313

14-
This error occurs when you deploy an app on Streamlit Community Cloud and have one or more of the following issues with your [Python dependencies](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies#add-python-dependencies) in your requirements file:
14+
This error occurs when you deploy an app on Streamlit Community Cloud and have one or more of the following issues with your [Python dependencies](/streamlit-community-cloud/deploy-your-app/app-dependencies#add-python-dependencies) in your requirements file:
1515

1616
1. The package is part of the [Python Standard Library](https://docs.python.org/3/py-modindex.html). E.g. You will see **`ERROR: No matching distribution found for base64`** if you include [`base64`](https://docs.python.org/3/library/base64.html) in your requirements file, as it is part of the Python Standard Library. The solution is to not include the package in your requirements file. Only include packages in your requirements file that are not distributed with a standard Python installation.
1717
2. The package name in your requirements file is misspelled. Double-check the package name before including it in your requirements file.

content/kb/dependencies/snowflake-connector-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The Snowflake Connector for Python is available on [PyPI](https://pypi.org/proje
1919

2020
5. On Streamlit Community Cloud, select the appropriate version of Python for your app by clicking "Advanced settings" before you deploy the app:
2121
<div style={{ maxWidth: '65%', marginBottom: '-3em', marginLeft: '6em', marginTop: '-2em' }}>
22-
<Image src="/images/streamlit-community-cloud/advanced-settings.png" />
22+
<Image src="/images/streamlit-community-cloud/deploy-an-app-advanced.png" />
2323
</div>
2424

2525
That's it! You're ready to use the Snowflake Connector for Python on Streamlit Community Cloud. ❄️🎈

content/kb/deployments/authentication-without-sso.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: /knowledge-base/deploy/authentication-without-sso
77

88
## Introduction
99

10-
Want to secure your Streamlit app with passwords, but cannot implement single sign-on? We got you covered! This guide shows you two simple techniques for adding basic authentication to your Streamlit app, using [secrets management](/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).
10+
Want to secure your Streamlit app with passwords, but cannot implement single sign-on? We got you covered! This guide shows you two simple techniques for adding basic authentication to your Streamlit app, using [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management).
1111

1212
<Warning>
1313

@@ -17,7 +17,7 @@ While this technique adds some level of security, it is **NOT** comparable to pr
1717

1818
## Option 1: One global password for all users
1919

20-
This is the easiest option! Your app will ask for a password that's shared between all users. It will be stored in the app secrets using [secrets management](/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). If you want to change this password or revoke a user's access, you will need to change it for everyone. If you want to have one password per user instead, jump to [Option 2 below](/knowledge-base/deploy/authentication-without-sso#option-2-individual-password-for-each-user).
20+
This is the easiest option! Your app will ask for a password that's shared between all users. It will be stored in the app secrets using [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management). If you want to change this password or revoke a user's access, you will need to change it for everyone. If you want to have one password per user instead, jump to [Option 2 below](/knowledge-base/deploy/authentication-without-sso#option-2-individual-password-for-each-user).
2121

2222
### Step 1: Add the password to your local app secrets
2323

@@ -37,7 +37,7 @@ Be sure to add this file to your `.gitignore` so you don't commit your secrets!
3737

3838
### Step 2: Copy your app secrets to the cloud
3939

40-
As the `secrets.toml` file above is not committed to GitHub, you need to pass its content to your deployed app (on Streamlit Community Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [secrets management](/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).
40+
As the `secrets.toml` file above is not committed to GitHub, you need to pass its content to your deployed app (on Streamlit Community Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management).
4141

4242
![Secrets manager screenshot](/images/databases/edit-secrets.png)
4343

@@ -89,7 +89,7 @@ If everything worked out, your app should look like this:
8989

9090
## Option 2: Individual password for each user
9191

92-
This option allows you to set a username and password for each user of your app. Like in [Option 1](#option-1-one-global-password-for-all-users), both values will be stored in the app secrets using [secrets management](/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).
92+
This option allows you to set a username and password for each user of your app. Like in [Option 1](#option-1-one-global-password-for-all-users), both values will be stored in the app secrets using [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management).
9393

9494
### Step 1: Add usernames & passwords to your local app secrets
9595

@@ -114,7 +114,7 @@ Alternatively, you could set up and manage usernames & passwords via a spreadshe
114114

115115
### Step 2: Copy your app secrets to the cloud
116116

117-
As the `secrets.toml` file above is not committed to GitHub, you need to pass its content to your deployed app (on Streamlit Community Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [secrets management](/streamlit-community-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management).
117+
As the `secrets.toml` file above is not committed to GitHub, you need to pass its content to your deployed app (on Streamlit Community Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management).
118118

119119
![Secrets manager screenshot](/images/databases/edit-secrets.png)
120120

content/kb/deployments/custom-subdomains.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /knowledge-base/deploy/custom-subdomains
55

66
# Custom subdomains
77

8-
Once you've [deployed your app](/streamlit-community-cloud/get-started/deploy-an-app) on Community Cloud, it's given an automatically generated subdomain that follows a structure based on your GitHub repo. This subdomain is unique to your app and can be used to share your app with others. However, the default subdomain is not always the most memorable or easy to share. E.g. the following is a bit of a mouthful!
8+
Once you've [deployed your app](/streamlit-community-cloud/deploy-your-app) on Community Cloud, it's given an automatically generated subdomain that follows a structure based on your GitHub repo. This subdomain is unique to your app and can be used to share your app with others. However, the default subdomain is not always the most memorable or easy to share. E.g. the following is a bit of a mouthful!
99

1010
`https://streamlit-demo-self-driving-streamlit-app-8jya0g.streamlit.app`
1111

@@ -15,20 +15,20 @@ You can instead set up a custom subdomain to make your app easier to share. You
1515
<your-custom-subdomain>.streamlit.app
1616
```
1717

18-
To customize your app subdomain from the [dashboard](/streamlit-community-cloud/get-started/manage-your-app#manage-apps-from-your-app-dashboard):
18+
To customize your app subdomain from your [workspace](/streamlit-community-cloud/manage-your-app#manage-your-app-from-your-workspace):
1919

2020
1. Click the "︙" overflow menu to the app's right and select "**Settings**".
2121

22-
![Custom subdomain settings](/images/streamlit-community-cloud/custom-subdomain-settings.png)
22+
![App settings](/images/streamlit-community-cloud/workspace-app-settings.png)
2323

2424
2. View the "**General**" tab in the App settings modal. Your app's unique subdomain will appear here.
25-
![Custom subdomain pick](/images/streamlit-community-cloud/custom-subdomain-pick.png)
25+
![General app settings](/images/streamlit-community-cloud/workspace-app-settings-general.png)
2626

2727
3. Pick a custom subdomain between 6 and 63 characters in length for your app's URL and hit "**Save**".
28-
![Custom subdomain save](/images/streamlit-community-cloud/custom-subdomain-save.png)
28+
![New custom subdomain](/images/streamlit-community-cloud/workspace-app-settings-general-valid-domain.png)
2929

3030
It's that simple! You can then access your app by visiting your custom subdomain URL 🎉.
3131

3232
If a custom subdomain is not available (e.g. because it's already taken), you'll see an error message like this:
3333

34-
![Custom subdomain error](/images/streamlit-community-cloud/custom-subdomain-error.png)
34+
![Invalid custom subdomain](/images/streamlit-community-cloud/workspace-app-settings-general-invalid-domain.png)

content/kb/deployments/huh-this-is-isnt-supposed-to-happen-message-after-trying-to-log-in.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ This message usually indicates that our system has linked your GitHub username w
2020
No worries – all you have to do is:
2121

2222
1. Log out of Streamlit Community Cloud completely (via both your email and GitHub accounts).
23-
2. Log in first with your email account (you can do so via either ["Continue with Google"](/streamlit-community-cloud/get-started#sign-in-with-google) or ["Continue with email"](/knowledge-base/deploy/sign-in-without-sso)).
24-
3. Log in with your [GitHub account](/streamlit-community-cloud/get-started#sign-in-with-email).
23+
2. Log in first with your email account (you can do so via either ["Continue with Google"](/streamlit-community-cloud/manage-your-account/sign-in-sign-out#sign-in-with-google) or ["Continue with email"](/knowledge-base/deploy/sign-in-without-sso)).
24+
3. Log in with your [GitHub account](/streamlit-community-cloud/manage-your-account/sign-in-sign-out#sign-in-with-email).

content/kb/deployments/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ slug: /knowledge-base/deploy
1414
- [App is not loading when running remotely](/knowledge-base/deploy/remote-start)
1515
- [Authentication without SSO](/knowledge-base/deploy/authentication-without-sso)
1616
- [I don't have GitHub or GSuite. How do I sign in to Streamlit Community Cloud?](/knowledge-base/deploy/sign-in-without-sso)
17-
- [How do I share apps with viewers outside my organization?](/knowledge-base/deploy/share-apps-with-viewers-outside-organization)
1817
- [Upgrade the Streamlit version of your app on Streamlit Community Cloud](/knowledge-base/deploy/upgrade-streamlit-version-on-streamlit-cloud)
1918
- [Organizing your apps with workspaces on Streamlit Community Cloud](/knowledge-base/deploy/organizing-apps-workspaces-streamlit-cloud)
2019
- [How do I increase the upload limit of `st.file_uploader` on Streamlit Community Cloud?](/knowledge-base/deploy/increase-file-uploader-limit-streamlit-cloud)

content/kb/deployments/invoking-python-subprocess-deployed-streamlit-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import sys
3434
subprocess.run([f"{sys.executable}", "script.py"])
3535
```
3636

37-
This ensures that `script.py` is running under the same Python executable as your Streamlit code—where your [Python dependencies](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies#add-python-dependencies) are installed.
37+
This ensures that `script.py` is running under the same Python executable as your Streamlit code—where your [Python dependencies](/streamlit-community-cloud/deploy-your-app/app-dependencies#add-python-dependencies) are installed.
3838

3939
### Relevant links
4040

0 commit comments

Comments
 (0)