add example apache config

This commit is contained in:
Ruben van de Ven 2022-09-12 11:23:05 +02:00
parent 8c850d22b4
commit 044a537ef3
2 changed files with 34 additions and 8 deletions

View file

@ -1,11 +1,5 @@
# [svganim] Drawing & annotation # [svganim] Drawing & annotation
This software allows for drawings to be made and played back in a time-based format. Additionally, it contains tools to create excerpts of the drawings and browse these segments by annotation.
This software was developed in light of a research project in which we used it in an interview setting. Asking speakers not just to speak, but to draw the entities they mention and the relations between them. This adds a visual layer on top of the audio.
For more information on the rationale behind developing this tool, see the [citation](#citation) section.
<p align="center"> <p align="center">
<a href="#getting-started">Getting Started</a> <a href="#getting-started">Getting Started</a>
<a href="#usage">Usage</a> <a href="#usage">Usage</a>
@ -14,6 +8,12 @@ For more information on the rationale behind developing this tool, see the [cita
<a href="#citation">Citation</a> <a href="#citation">Citation</a>
</p> </p>
This software allows for drawings to be made and played back in a time-based format. Additionally, it contains tools to create excerpts of the drawings and browse these segments by annotation.
This software was developed in light of a research project in which we used it in an interview setting. Asking speakers not just to speak, but to draw the entities they mention and the relations between them. This adds a visual layer on top of the audio.
For more information on the rationale behind developing this tool, see the [citation](#citation) section.
## Getting Started ## Getting Started
@ -66,7 +66,7 @@ When the service runs, open it using your browser. The first page shows three op
* add an audio recording of the conversation to `files/audio`. Note that a wav file can be quite slow as everything goes through a browser. So possibly convert wav to mp3 or ogg. * add an audio recording of the conversation to `files/audio`. Note that a wav file can be quite slow as everything goes through a browser. So possibly convert wav to mp3 or ogg.
* Open the drawing in the interface URL/annotate.html. Hover the title on the top left, and select the audio file from the pull down. * Open the drawing in the interface URL/annotate.html. Hover the title on the top left, and select the audio file from the pull down.
* Use the _Offset_ parameter to align the audio to the drawing (number in seconds). * Use the _Offset_ parameter to align the audio to the drawing (number in seconds).
* _NOTE_: The diagram starts recoding on the first stroke. Often the audio file starts before the drawing. This requires a _negative_ offset. * **NOTE** The diagram starts recoding on the first stroke. Often the audio file starts before the drawing. This requires a _negative_ offset.
* The title of the drawing can be set and changed by clicking on it. * The title of the drawing can be set and changed by clicking on it.
* To annotate, select an in and out point using the bar below the drawing. * To annotate, select an in and out point using the bar below the drawing.
* Alternatively, in and out point can be set to the playhead `i` and `o` keys. * Alternatively, in and out point can be set to the playhead `i` and `o` keys.
@ -102,7 +102,7 @@ The `parse_offsets.py` script can be used to pad the diagram in order to sync it
## License ## License
This code is made available under the MIT license. For details see [LICENSE](./LICENSE) This code is made available under the MIT license. For details see [LICENSE](./LICENSE).
## Credits ## Credits

View file

@ -0,0 +1,26 @@
<VirtualHost *:80>
# This is the HTTP example, ideally use Certbot/LetsEncrypt to encrypt the data transferred
Servername diagramming.WEBSITE
<Location />
# Optionally use some basic auth to prevent access to anyone.
AuthType Basic
Authname "Password Required"
AuthUserFile /etc/apache2/.htpasswd
Require valid-user
</Location>
RewriteEngine On
RewriteCond %{HTTP:Upgrade} =websocket [NC]
RewriteRule /(.*) ws://localhost:7890/$1 [P,L]
RewriteCond %{HTTP:Upgrade} !=websocket [NC]
RewriteRule /(.*) http://localhost:7890/$1 [P,L]
ProxyPass / http://localhost:7890/
ProxyPassReverse / http://localhost:7890/
ProxyPreserveHost On
</VirtualHost>