assets | ||
configs | ||
lib | ||
model | ||
template | ||
view | ||
.gitignore | ||
.htaccess | ||
50x.html | ||
404.html | ||
build.htaccess | ||
build.sh | ||
config.php | ||
index.php | ||
README.md | ||
serve.sh |
C3VOC Streaming-Webseite
Dies ist der Code für die Streaming-Webseite unter streaming.media.ccc.de, welche vom C3VOC benutzt wird, um Live-Video- und -Audio-Streams von diversen Konferenzen im Internet zu präsentieren. Die Idee hinter diesem Projekt ist es, eine generische Codebasis zu haben, die mit wenigen Konfigurationsoptionen und ein paar CSS-Rules an die Gegebenheiten und die Gestaltung der Konferenz angepasst werden können.
Development
Während der Entwicklung kann der eingebaute PHP-Webserver verwendet werden:
$ ./serve.sh
PHP 7.0.4-7ubuntu2.1 Development Server started at Mon Jun 20 22:40:17 2016
Listening on http://localhost:8000
Document root is /home/peter/VOC/streaming-website
Press Ctrl-C to quit.
…
Unterstützt wird PHP ab 5.4.
Setup
Das Setup beim VOC besteht aus einem Hidden-Master-Server, welcher den PHP-Code
in einem nginx ausführt. Dahinter kommen n
Frontend-Caches, wobei für kleine
Events n
eigentlich fast immer =1
ist. Für große Events (Camp, Congress)
können wir aber sehr einfach weitere Frontend-Caches bei verschiedenen Hostern
hinzu deployen.
Zur Vorbereitung einer Konferenz oder zur Weiterentwickelung der Seite ist es hilfreich, sich das Teil lokal aufzusetzen. Am einfachsten geht das mit 'nem Apachen, denn die beiliegende .htaccess konfiguriert das URL-Rewriting gleich richtig. Bei nginx muss das in der globalen nginx.conf ungefähr so eingestellt werden:
location / {
rewrite /(.*) /index.php?route=$1 last;
}
Abweichend von der Default-Config muss in PHP das Flag short_open_tag = On
gesetzt werden.
Konfiguration
Die Seite kann für mehrere parallel laufende Konferenzen gleichzeitig verwendet werden. Jede Konferenz wird über einen Ordner unterhalb von configs/conferences konfiguriert. In diesen Ordnern können jeweils folgende Dateien abgelegt werden, welche das Verhalten bzw. die Gestaltung der jeweiligen Konferenzseite bestimmen, im Folgendem am :
- config.php – steuert das Verhalten der gesamten Konferenzseite. Diese ist ausführlich dokumentiert und sollte sich selbst erklären.
- download.sh – Wird von einem Cronjob in regelmäßigen Abständen zum Herunterladen von
schedule.xml
-Dateien und anderen Drittkonfiguration verwendet. - main.less – steuert die Gestaltung der Konferenzseite.
- weitere Assets wie
.png
oder.svg
-Dateien, die aus dermain.less
heraus referenziert werden können.
Deployment (auf der VOC Infrastruktur)
ssh voc@live.ber
cd /srv/nginx/streaming-website
git fetch origin
git checkout <branch>
sudo sh -c 'rm -rf /srv/nginx/cache/streaming_fcgi/*'
exit
ssh voc@live.dus
sudo sh -c 'rm /srv/nginx/cache/streaming_website/static/* /srv/nginx/cache/streaming_website/pages/*'
exit
JSON-API
Unter der URL http://streaming.media.ccc.de/streams/v1.json bietet die Steaming-Webseite eine Übersicht über alle konfigurierten Räume und Streams in einem maschinenlesbaren Format an. Dieses kann z.B. genutzt werden, um in den diversen Anwendungen, die sich rund um das Konferenzgeschehen entwickelt haben, Player und Links zu Liveübertragungen anzubieten.
Wie die URL vermuten lässt, ist die API versioniert. Dies bedeutet, dass in
der v1.json
keine Felder entfernt werden oder ihre Bedeutung ändern – es
können aber durchaus neue Felder hinzukommen. Eine formalere Spezifikation
des JSON-Formats ist tbd. Ein Beispiel kann hier
betrachtet werden.