Skip to content

Update Community Cloud docs #766

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

Merged
merged 47 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
765dee8
Community Cloud sign-up and account instructions
sfc-gh-dmatthews Jul 22, 2023
df6db3f
Wording clarity
sfc-gh-dmatthews Jul 22, 2023
aeadd89
Delete duplicate images
sfc-gh-dmatthews Jul 22, 2023
77a6fd9
Update sign-in instructions and images
sfc-gh-dmatthews Jul 22, 2023
183ebee
Update sign-in-email-3.png
sfc-gh-dmatthews Jul 22, 2023
113bd9f
Update Community Cloud Get started
sfc-gh-dmatthews Jul 24, 2023
ed309a7
Update images & move GitHub connection details
sfc-gh-dmatthews Jul 25, 2023
a9fe6b9
Updated Community Cloud re:default URL
sfc-gh-dmatthews Jul 25, 2023
c7ef034
Updated custom subdomain images
sfc-gh-dmatthews Jul 25, 2023
9875385
Update app-dependencies.md
sfc-gh-dmatthews Jul 25, 2023
cf19722
Prettify Python package managers table
sfc-gh-dmatthews Jul 25, 2023
6c7efe6
Remove Workspace analytics
sfc-gh-dmatthews Jul 25, 2023
b22560b
Edits for clarity
sfc-gh-dmatthews Jul 27, 2023
19f8799
Move connecting to GitHub
sfc-gh-dmatthews Jul 27, 2023
8c01a5b
Delete duplicate Connect GitHub
sfc-gh-dmatthews Jul 27, 2023
ecf6c4a
Remove duplicate Connect to data sources index
sfc-gh-dmatthews Jul 27, 2023
a465ba3
Rearrange folder structure in Community Cloud
sfc-gh-dmatthews Jul 27, 2023
6c0f1e4
Update Get started/Connect GitHub
sfc-gh-dmatthews Jul 27, 2023
3e0b515
Add Community Cloud Quickstart
sfc-gh-dmatthews Jul 28, 2023
290f363
Added GItHub account management
sfc-gh-dmatthews Jul 28, 2023
ce8a1ac
Update links
sfc-gh-dmatthews Jul 28, 2023
3a50560
Update Streamlit Community Cloud index.md
sfc-gh-dmatthews Aug 1, 2023
821725e
Split Get started in Community Cloud
sfc-gh-dmatthews Aug 1, 2023
da6fb52
Update Community Cloud Quickstart
sfc-gh-dmatthews Aug 1, 2023
8422ca1
Update account creation in Get started
sfc-gh-dmatthews Aug 1, 2023
2168cdc
Link updates and clarity edits
sfc-gh-dmatthews Aug 1, 2023
6a1a47e
Edit for enterprise language
sfc-gh-dmatthews Aug 1, 2023
109c253
Update secrets management in Community Cloud
sfc-gh-dmatthews Aug 2, 2023
c654e9f
Update Share your app
sfc-gh-dmatthews Aug 2, 2023
2cb00e6
Update Embed your app
sfc-gh-dmatthews Aug 3, 2023
b83447e
Update indexability.md
sfc-gh-dmatthews Aug 3, 2023
e5bd62f
Update share-previews.md
sfc-gh-dmatthews Aug 3, 2023
20ec4fe
Create app-analytics.md
sfc-gh-dmatthews Aug 3, 2023
0839e5a
Create favorite-your-app.md
sfc-gh-dmatthews Aug 3, 2023
105120b
Create reboot-your-app.md
sfc-gh-dmatthews Aug 3, 2023
ecdee29
Create delete-you-app.md
sfc-gh-dmatthews Aug 3, 2023
468e24e
Update index.md for Manage your app
sfc-gh-dmatthews Aug 3, 2023
a1e32b4
Create workspace-settings.md
sfc-gh-dmatthews Aug 3, 2023
5b34fa0
Update links, images, and image descriptions
sfc-gh-dmatthews Aug 5, 2023
843a8f4
Update links, images, and image descriptions (Share your app)
sfc-gh-dmatthews Aug 6, 2023
1911e9f
Remove localhost from link
sfc-gh-dmatthews Aug 6, 2023
3876084
Update links, images, and image descriptions (Manage your account sec…
sfc-gh-dmatthews Aug 6, 2023
8eef46a
Small fixes and typos
sfc-gh-dmatthews Aug 8, 2023
dea41e9
Update main, Community Cloud page
sfc-gh-dmatthews Aug 8, 2023
76500fe
Update links to Community Cloud section
sfc-gh-dmatthews Aug 8, 2023
8cdd5db
Update header links to Streamlit Community Cloud section
sfc-gh-dmatthews Aug 8, 2023
842ae11
Update redirects for Community Cloud
sfc-gh-dmatthews Aug 8, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/kb/dependencies/install-package-pypi-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /knowledge-base/dependencies/install-package-not-pypi-conda-available-gith

## Overview

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!
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!

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`.

Expand Down
2 changes: 1 addition & 1 deletion content/kb/dependencies/libgl.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If you use OpenCV in your app, include `opencv-python-headless` in your requirem

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:

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`:
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`:

```
libgl1
Expand Down
2 changes: 1 addition & 1 deletion content/kb/dependencies/module-not-found-error.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You receive the error `ModuleNotFoundError: No module named` when you deploy an

## Solution

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.
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.

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.

Expand Down
2 changes: 1 addition & 1 deletion content/kb/dependencies/no-matching-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You receive the error `ERROR: No matching distribution found for` when you deplo

## Solution

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:
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:

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.
2. The package name in your requirements file is misspelled. Double-check the package name before including it in your requirements file.
Expand Down
2 changes: 1 addition & 1 deletion content/kb/dependencies/snowflake-connector-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The Snowflake Connector for Python is available on [PyPI](https://pypi.org/proje

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

That's it! You're ready to use the Snowflake Connector for Python on Streamlit Community Cloud. ❄️🎈
Expand Down
10 changes: 5 additions & 5 deletions content/kb/deployments/authentication-without-sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /knowledge-base/deploy/authentication-without-sso

## Introduction

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).
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).

<Warning>

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

## Option 1: One global password for all users

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).
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).

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

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

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

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).
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).

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

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

## Option 2: Individual password for each user

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).
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).

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

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

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

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).
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).

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

Expand Down
12 changes: 6 additions & 6 deletions content/kb/deployments/custom-subdomains.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /knowledge-base/deploy/custom-subdomains

# Custom subdomains

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!
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!

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

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

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

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

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

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

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

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

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

![Custom subdomain error](/images/streamlit-community-cloud/custom-subdomain-error.png)
![Invalid custom subdomain](/images/streamlit-community-cloud/workspace-app-settings-general-invalid-domain.png)
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ This message usually indicates that our system has linked your GitHub username w
No worries – all you have to do is:

1. Log out of Streamlit Community Cloud completely (via both your email and GitHub accounts).
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)).
3. Log in with your [GitHub account](/streamlit-community-cloud/get-started#sign-in-with-email).
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)).
3. Log in with your [GitHub account](/streamlit-community-cloud/manage-your-account/sign-in-sign-out#sign-in-with-email).
1 change: 0 additions & 1 deletion content/kb/deployments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ slug: /knowledge-base/deploy
- [App is not loading when running remotely](/knowledge-base/deploy/remote-start)
- [Authentication without SSO](/knowledge-base/deploy/authentication-without-sso)
- [I don't have GitHub or GSuite. How do I sign in to Streamlit Community Cloud?](/knowledge-base/deploy/sign-in-without-sso)
- [How do I share apps with viewers outside my organization?](/knowledge-base/deploy/share-apps-with-viewers-outside-organization)
- [Upgrade the Streamlit version of your app on Streamlit Community Cloud](/knowledge-base/deploy/upgrade-streamlit-version-on-streamlit-cloud)
- [Organizing your apps with workspaces on Streamlit Community Cloud](/knowledge-base/deploy/organizing-apps-workspaces-streamlit-cloud)
- [How do I increase the upload limit of `st.file_uploader` on Streamlit Community Cloud?](/knowledge-base/deploy/increase-file-uploader-limit-streamlit-cloud)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import sys
subprocess.run([f"{sys.executable}", "script.py"])
```

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.
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.

### Relevant links

Expand Down
4 changes: 2 additions & 2 deletions content/kb/deployments/resource-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /knowledge-base/deploy/resource-limits

# Argh. This app has gone over its resource limits

Sorry! It means you've hit the [resource limits](/streamlit-community-cloud/get-started/manage-your-app#app-resources-and-limits) of your [Streamlit Community Cloud](https://streamlit.io/cloud) account.
Sorry! It means you've hit the [resource limits](/streamlit-community-cloud/manage-your-app#app-resources-and-limits) of your [Streamlit Community Cloud](https://streamlit.io/cloud) account.

<!-- One way to avoid this is to [upgrade your plan](https://streamlit.io/cloud) to one with higher resource limits. -->

Expand All @@ -17,7 +17,7 @@ There are a few things you can change in your app to make it less resource-hungr
- Move big datasets to a database
- Profile your app's memory usage

Check out our [blog post](https://blog.streamlit.io/common-app-problems-resource-limits/) on [“Common app problems: Resource limits"](https://blog.streamlit.io/common-app-problems-resource-limits/) for more in-depth tips prevent your app from hitting the [resource limits](/streamlit-community-cloud/get-started/manage-your-app#app-resources-and-limits) of the Streamlit Community Cloud.
Check out our [blog post](https://blog.streamlit.io/common-app-problems-resource-limits/) on [“Common app problems: Resource limits"](https://blog.streamlit.io/common-app-problems-resource-limits/) for more in-depth tips prevent your app from hitting the [resource limits](/streamlit-community-cloud/manage-your-app#app-resources-and-limits) of the Streamlit Community Cloud.

Related forum posts:

Expand Down

This file was deleted.

Loading