3x3cut0r/streamlit repository overview

⁠streamlit

Streamlit - an open-source app framework for Machine Learning and Data Science teams

GitHub - 3x3cut0r/streamlit - https://github.com/3x3cut0r/docker/tree/main/streamlit⁠
DockerHub - 3x3cut0r/streamlit - https://hub.docker.com/r/3x3cut0r/streamlit⁠

⁠Index

1. Configuration⁠
   1.1 streamlit_app.py⁠
   1.2 requirements.txt⁠
   1.3 .streamlit/config.toml⁠
2. Usage⁠
   2.1 docker run⁠
   2.2 docker-compose.yaml⁠
3. Environment Variables⁠
4. Volumes⁠
5. Ports⁠
6. Find Me⁠
7. License⁠

⁠1 Configuration

⁠1.1 streamlit_app.py

your streamlit app folder must contain a 'streamlit_app.py' as the main streamlit app!

streamlit_app.py

import streamlit as st
st.title("This is my Streamlit app")
...

⁠1.2 requirements.txt

if your streamlit app needs special python dependencies, your streamlit app folder must contain a 'requirements.txt' with each dependency in one line. e.g.:

requirements.txt

tensorflow
uvicorn==0.12.2
fastapi>=0.63.0

⁠1.3 .streamlit/config.toml

if your streamlit app needs special configuration options, your streamlit app folder should contain a '.streamlit' folder with a 'config.toml' file. e.g.:

.streamlit/config.toml, visit Streamlit Documentation - Configuration⁠ for more information

[server]
enableCORS=false
enableStaticServing = true
enableXsrfProtection=false

[browser]
gatherUsageStats = false

⁠2 Usage

⁠2.1 docker run

your streamlit app folder must contain a 'streamlit_app.py' as the main streamlit app

docker run -d \
    --name streamlit \
    -e TZ="Europe/Berlin" \
    -v /path/of/your/streamlit/app:/app \
    -p 8501:8501/tcp \
    3x3cut0r/streamlit:latest

⁠2.2 docker-compose.yml

your streamlit app folder must contain a 'streamlit_app.py' as the main streamlit app

version: '3.9'
services:
  # https://hub.docker.com/r/3x3cut0r/streamlit
  streamlit:
    image: 3x3cut0r/streamlit:latest
    environment:
        TZ: Europe/Berlin
    volumes:
      - /path/of/your/streamlit/app:/app
    ports:
      - 8501:8501/tcp

⁠3 Environment Variables

• TZ - Specifies the server timezone - Default: UTC
• PORT - Specifies port number - Default: 8501

⁠4 Volumes

• /app - streamlit app directory -> your streamlit app folder must contain a 'streamlit_app.py' as the main streamlit app

⁠5 Ports

• 8501/tcp - HTTP Port

⁠6 Find Me

• GitHub⁠
• DockerHub⁠

⁠7 License

- This project is licensed under the GNU General Public License - see the gpl-3.0⁠ for details.