Share your app
Now that your app is deployed you can easily share it and collaborate on it. But first, let's take a moment and do a little joy dance for getting that app deployed! 🕺💃
Your app is now live at that fixed URL, so go wild and share it with whomever you want. Your app will inherit permissions from your GitHub repo, meaning that if your repo is private your app will be private and if your repo is public your app will be public. If you want to change that you can simply do so from the app menu.
There are three primary ways to share your app with viewers. You can either directly add viewers from the in-app share menu, or do so from the Cloud logs menu, or from your app dashboard.
Sharing private apps
By default all apps deployed from private source code are private to the developers in the workspace. Your apps will not be visible to anyone else unless you grant them explicit permission. You can grant permission either in your workspace or from the app itself.
What is viewer auth?
Viewer auth allows you to restrict the viewers of your app. To access your app, users have to authenticate using an email-based passwordless login or Google OAuth.
Configuring single sign-on
Google OAuth is enabled by default, so if you use Google, you're good to go.
Once you have added someone's email address to your app's viewer list, that person will be able to sign in via Google Single Sign-On and view your app. They will also receive an email inviting them to view your app. If they are already logged in with that account in their browser (the usual case for most people) then they will automatically be able to view the app. If they are not logged in, or they have not been giving access, then they will see a page asking them to first log in.
Having trouble granting access? Is a viewer having trouble logging on? See our troubleshooting section for help.
Adding viewers from the in-app share menu
You can add viewers from the in-app share menu by clicking the "Share" button in the top right corner of your deployed app.
- Click "Share" in the top right corner.
- Enter the email addresses of the viewers.
It's that easy! The viewers you have added will receive an email inviting them to visit your app. The most recently added viewers will appear at the top of the list in the in-app share menu.
To remove a viewer, simply hover over their email address and click "X" that appears to the right:
Developers, invited viewers, and members of your workspace can all see the in-app share menu, read the list of viewers, and add and remove viewers.
Only developers are allowed to toggle whether the app is public or private. App viewers don't have permission to change this setting.
Adding viewers from the Cloud logs menu
From your deployed app you can easily add viewers from your Cloud logs menu.
- Select "Manage app" in the lower right corner.
- Choose "Settings" from the menu.
Add Viewers in Settings.
You can choose to allow anyone from a domain, for example allowing "foo.corp" would allow anyone with an email from foo.corp. Or you can choose to allow only selected viewers based on their individual emails. Make sure to enter them as a line-separated list.
Adding viewers from the app dashboard
You can also add viewers directly from your dashboard.
Open settings for your app
Navigate to the app you want to add viewer to and click the hamburger icon to select "Settings."
Add Viewers in Settings
Click on the "Sharing" section in the App Settings and in the text input area, provide a line-separated list of email addresses for the users you wish to grant viewer access to your app, or provide a line-separated list of allowed email address domains. Click "Save."
Sharing public apps
From your deployed app you can click on the "☰" menu on the top right and select 'Share this app' to post it directly into social media or to share with the community on our Community forum. We'd love to see what you make and perhaps feature your app as our app of the month ❤️.
Add a GitHub badge
To help others find and play with your Streamlit app, you can add Streamlit's GitHub badge to your repo. Below is an example of what the badge looks like. Clicking on the badge takes you to, in this case, Streamlit's Face-GAN Demo.
Once you deploy your app, you can embed this badge right into your GitHub README.md by adding the following Markdown:
Be sure to replace
https://<your-custom-subdomain>.streamlitapp.com with the URL of your deployed app!
Inviting other developers is simple, just invite them to your GitHub repository so that you can code on apps together, and then have them log in to share.streamlit.io. If you are working as a team, you likely are already in the same repos, so skip step 1 and go straight to having them log into share.streamlit.io
Streamlit Cloud inherits developer permissions from GitHub, so when your teammates log in, they will automatically view the workspaces you share. From there you can all deploy, manage, and share apps together.
Pushing new code
You can also collaborate with other developers by having multiple contributors pushing to the same GitHub repo. Whenever anyone on the team updates the code on GitHub, the app will also automatically update for you!
If you want to try out something new while still keeping your original app running, just create a new branch, make some changes, and deploy a new version of the Streamlit app.
Finding app code
Every deployed app has its Github source code linked in the "☰" menu on the top right. So if you are looking to understand the code of another Streamlit app, you can navigate to the GitHub page from there and read or fork the app.