README

Important

This project is no longer actively maintained.

The source code in this repository is no longer maintained. It has been superseded by version 2, which offers improved features and better support.

Thank you to all who have contributed to this project. We recommend transitioning to Os2Display version 2 for continued support and updates.

Final Release: The final stable release is version 1.1.7

OS2Display screen-bundle

Bundle to add a screen frontend to the administration.

Description

This bundle adds screen as a bundle to the administration. Furthermore, it adds a new pull strategy to the frontend, where a middleware is not needed. If this strategy is chosen the options to reload the screen from the adminstration are lost.

By moving the screen into the adminstration the possibility of a preview of screens and channels in the administration has been added.

There is also a possibility of making public channels/screens that have a public url. This url can be opened by multiple browsers and uses the pull strategi.

Configuration

Add the following to routing.yml:

os2display_screen:
    resource: "@Os2DisplayScreenBundle/Resources/config/routing.yml"
    prefix:   /

Add the following to security.yml firewalls section:

screen_bundle_public:
    pattern: ^/screen/public/(.*)
    security: false

nginx setup

The following should be added to the admin nginx conf.

    location /middleware/ {
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;

        proxy_buffering off;

        proxy_pass http://nodejs_middleware/;
        proxy_redirect off;
    }

Alternatively this location name can be

Access screen with middleware

To open screen go to /screen/.

Access screen without middleware

Go to the administration under a screen. Make it publicly available. Distribute the url.

Configuration reference

These are the default config values (config.yml).

os2_display_screen:
    strategies:
       pull:
            enabled: true
            debug: false
            log_to_console: false
            log_level: error
            update_path: /screen/serialized
            # in seconds
            update_interval: 300
        push:
            enabled: true
            debug: false
            log_to_console: false
            log_level: error
            resource:
                server: '%absolute_path_to_server%/'
                uri: 'middleware'
            ws:
                server: '%middleware_host%'
            apikey: ''
            cookie:
                secure: false

Develop config

To enable debug information in develop mode, add the following to config_dev.yml.

os2_display_screen:
    strategies:
        pull:
            debug: true
            log_to_console: true
            log_level: all
        push:
            debug: true
            log_to_console: true
            log_level: all