Skip to content
Henri edited this page Jun 29, 2018 · 16 revisions

Developer documentation

You can find our technical documentation at https://finsl-signbank.readthedocs.io

HTTPS

It is recommended that you run FinSL-signbank with HTTPS only, with one exception: You need to server externally controlled vocabularies for ELAN with HTTP!

You can find more information about setting up HTTPS from django's docs https://docs.djangoproject.com/en/stable/topics/security/#ssl-https

Serving Static and Media files

It is recommended to serve static files and media files with the web server instead of serving them with the application. You can set these folders in settings as STATIC_ROOT and MEDIA_ROOT.

STATIC_ROOT is used for static files that come with FinSL-signbank and its dependencies.

To move the files to the STATIC_ROOT of your choice (which should be served by the web server) use Djangos collectstatic command https://docs.djangoproject.com/en/stable/ref/contrib/staticfiles/#django-admin-collectstatic. If you use Apache, set an Alias to server /static/ url to the directory where you have set static files to be copied to https://httpd.apache.org/docs/current/mod/mod_alias.html.

MEDIA_ROOT is used for the media files uploaded by the users.

Serve this folder with the web server of your choice. If you use Apache, you can set an Alias to serve /media/ url to the directory of your choice https://httpd.apache.org/docs/current/mod/mod_alias.html.

FinSL-signbank's apps

Dictionary

Dictionary is the main application of FinSL-signbank. It holds the Glosses and important data and information of them.

Video

Handles the video storage. There are plans to replace this with signbank-video