Welcome to StreetSign’s documentation!

StreetSign is a Digital Signage System, built using Python, Flask, and a bunch of wonderful libraries, designed to be as simple and friendly as possible.

This documentation is a work in progress.

Contents:

• Getting Started
  • System Requirements
  • Installing
  • Basic Overview
    • Content
    • Displaying it all
    • Timing things
    • Permissions
    • That’s it!
  • Notes when using the system
    • Magic Variables
    • Post Sizing/Scaling
• Screen Design
  • Backgrounds
  • Zones
    • Types of Zone Animation
    • Size
    • Fonts
    • Other CSS
  • Screen ‘client aliases’
  • Screen “over-ride” Options
    • Aspect Ratio
    • Fade Time
    • Scroll Speed
• StreetSign Admin’s guide
  • Installation
  • Running it.
    • Some links:
  • Users
    • Account lockout
  • Password hashes and moving the database
  • Housekeeping & removing old content
  • Server Time
  • Configuration Reference
  • Logging
  • Backup & Restore
  • Health Check
• Deploying Streetsign in Production
  • Dependencies
  • User/Group
  • Installation path
  • Actually Installing it
  • Set a secret key
  • Test it’s all ready to go
  • Configure streetsign to start on system-boot
    • systemd systems (Ubuntu 16.04+, CentOS/RHEL 7+, Debian 8+, etc)
  • Getting Streetsign on to Port 80
    • nginx
    • Docker
    • CentOS Notes: (Esp. SELinux)
• StreetSign Developer Documentation
  • Project Structure Overview
    • __init__.py
    • models/
    • user_session.py
    • views/
    • logic/
    • static/
    • Other files in the root directory
  • API/Urls
  • How Post Types work
  • How External Data Types Work
  • How the ‘Screens’ Work
  • How Different Libraries are used
  • Testing & CI
    • Continuous Integration
• StreetSign Developer Reference
  • API/Urls
    • /health
    • /robots.txt
    • /screens/
    • /screens-edit/<int:screenid>
    • /screens/<template>/<screenname>
    • /screens/json/<int:screen_id>
    • /screens/posts_from_feeds/<[list,of,feed,ids]>
    • /screens/post_types.js
    • /aliases
    • /client/<alias_name>
    • /feeds/
    • /feeds-edit/<int:feedid>
    • /posts/
    • /post-edit/<int:postid>
    • /posts/<int:postid>/json
    • /posts/housekeeping
    • /posts/delete_orphaned_media
    • /post/<int:postid>/publish
    • /login
    • /logout
    • /users/
    • /users-edit/<int:userid>
    • /groups/
    • /groups-edit/<int:groupid>
    • /user_settings/
    • /file_browser/
    • /file_browser/<path:subdir>
    • /user_files/<path:filename>
    • /thumbnail/<path:filename>
  • streetsign_server.models
    • Utility functions
    • Database initialisation
    • Users and Groups
    • Login Stuff
    • Posts and Feeds
    • Screens and Output
    • Misc
  • streetsign_server.user_session
    • NotLoggedIn
    • get_user()
    • is_admin()
    • logged_in()
    • login()
    • logout()
  • streetsign_server.views
    • streetsign_server.views
    • before_the_action()
    • health()
    • index()
    • inject_csrf()
    • not_logged_in()
    • robots_txt()
    • Utilities
    • Users and Authentication
    • The Screen Output Views
    • Feeds and Posts
    • User uploaded files
  • streetsign_server.logic
    • Feeds and Posts
    • URL Safety
  • streetsign_server.post_types
    • Post Type Generic Module Overview
    • Rendering Screen Zones
  • streetsign_server.external_source_types
    • The main external Source Types:
    • The RSS Source Type
    • The Local Folder Source Type
• External Libraries
  • Flask
  • Peewee
    • Playhouse (Peewee migrations)
  • Sqlite
  • WhiteNoise
  • Bleach
  • FeedParser
  • bcrypt
  • Waitress
  • simpleeval
  • Jinja2
  • Werkzeug
  • MarkupSafe
  • Alpine.js
  • Bootstrap 5
  • Bootstrap Icons
  • jQuery
  • Quill
  • Choices.js
  • Flatpickr
  • Day.js
  • Prism.js
  • Pylint

Indices and tables

• Index

• Module Index

• Search Page