Welcome to StreetSign’s documentation!

StreetSign is a Digital Signage System, build 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
  • Instalation
  • Running it.
    • Some links:
  • Users
  • Password hashes and moving the database
  • Housekeeping & removing old content
  • Server Time
• Deploying Streetsign in Production
  • Dependencies
  • User/Group
  • Installation path
  • Actually Installing it
  • Test it’s all ready to go
  • Configure streetsign to start on system-boot
    • systemd systems (Ubuntu 15.x, CentOS 7, Debian Jessie, etc)
    • (Recent) upstartd systems (Ubuntu 14.x, etc)
    • SysV (initscript) systems (CentOS 6.x, etc.)
  • Getting Streetsign on to Port 80
    • nginx
    • Apache
    • CentOS Notes: (Esp. SELinux)
• StreetSign Developer Documentation
  • Project Structure Overview
    • __init__.py
    • models.py
    • user_session.py
    • views/
    • logic/
    • static/
    • “Lets Minify And Join all the Javascripts!!!”
    • 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
• StreetSign Developer Reference
  • API/Urls
    • /screens/<template>/<screenname>
    • /screens/json/<int:screen_id>
    • /screens/posts_from_feeds/<[list,of,feed,ids]>
    • /screens/post_types.js
  • streetsign_server.models
    • Useful functions
    • Users and Groups
    • Login Stuff
    • Posts and Feeds
    • Screens and Output
    • Misc
  • streetsign_server.user_session
  • streetsign_server.views
    • Utilites
    • Users and Authentication
    • The Screen Output Views
    • Feeds and Posts
    • User uploaded files
  • streetsign_server.logic
  • streetsign_server.post_types
    • Post Type Generic Module Overview
    • Rendering Screen Zones
    • And finally
  • streetsign_server.external_source_types
    • The main external Source Types:
    • The RSS Source Type
• External Libraries
  • Flask
  • Peewee
    • Flask-Peewee
  • Sqlite
  • jQuery
    • jQuery.transit
    • chosen
  • knockout.js
    • knockout.mapping
  • Twitter Bootstrap
  • bootstrap-wysihtml5 & wysihtml5
  • bootstrap-datetimepicker
  • Pylint
    • pylint git commit hook
  • Bleach
  • FeedParser
  • Passlib & py-bcrypt
  • Waitress

Indices and tables

• Index
• Module Index
• Search Page