new pages

compose.yaml

@@ -0,0 +1,76 @@
+services:
+  Glympse:
+    image: git.themainframe.co.uk/josh/glympse
+    container_name: Glympse
+    restart: unless-stopped
+    ports:
+      - 8080:80
+    environment:
+      TZ: Europe/London
+      ENABLE_UWSGI: yes
+      ENABLE_NGINX: yes
+      ENABLE_CELERY_BEAT: yes
+      ENABLE_PROCESSING: yes
+      ENABLE_MIGRATIONS: yes
+      ENABLE_TRANSCRIBER: no
+      ENABLE_TRANSCODER: no
+      DJANGO_SETTINGS_MODULE: Glympse.settings.dev
+      SECRET_KEY: "%bcfCLGtkg&KucAAg*KnUeENBUT6xv5wJDb^@Yz#&vn%n2Lod8dinEyNoC^usBv"
+      SECRET_ADMIN_URL: bWBgVqaj8p95huSud
+      CSRF_TRUSTED_ORIGINS: http://127.0.0.1
+      ALLOWED_HOSTS: 127.0.0.1
+      ADMINS: admin@glympsevideo.com
+      DOMAIN: glympse.glympsevideo.com
+      SQL_ENGINE: django.db.backends.mysql
+      SQL_DATABASE: glympse
+      SQL_USER: glympse
+      SQL_PASSWORD: GdhKngTjC9AM5gqCm32L
+      SQL_HOST: mysql
+      SQL_PORT: 3306
+      EMAIL_HOST: mail.themainframe.co.uk
+      EMAIL_PORT: 587
+      EMAIL_USE_TLS: "True"
+      EMAIL_HOST_USER: noreply@glympsevideo.com
+      EMAIL_HOST_PASSWORD: insecure_password
+      DEFAULT_FROM_EMAIL: Glympse<glympse@glympsevideo.com>
+      ALLOWED_EMAIL_DOMAINS: glympsevideo.com
+      REDIS_HOST: redis://redis:6379
+      RABBITMQ_URL: amqp://glympse:QdDlBh0PdaqV2lH4xnXG@rabbitmq:5672/glympse
+      ADMIN_USERNAME: hub
+      ADMIN_EMAIL: admin@glympsevideo.com
+      ADMIN_PASSWORD: ZHNp2432
+      LOG_LEVEL: DEBUG
+      TIMEZONE: Europe/London
+      MICROSOFT_AUTH_CLIENT_ID: None
+      MICROSOFT_AUTH_CLIENT_SECRET: None
+      MICROSOFT_AUTH_TENANT_ID: None
+      MEMCACHED: memcached:11211
+      CUDA_DEVICE: cuda:0
+      DEBUG: "True"
+      REMOTE_WORKER: "False"
+      REMOTE_PRODUCTION: None
+    volumes:
+      - /opt/glympse/logs:/Glympse/logs
+      - /media:/media
+      - /rushes:/rushes:ro
+    deploy:
+      resources:
+        reservations:
+          devices:
+            - driver: nvidia
+              device_ids:
+                - 00000000:01:00.0
+              capabilities:
+                - gpu
+    networks:
+      glympse: null
+  memcached:
+    image: memcached:latest
+    container_name: memcached
+    entrypoint: memcached -m 256
+    restart: unless-stopped
+    networks:
+      glympse: null
+networks:
+  glympse:
+    external: true

content/docs/Installation/database.md

@@ -73,9 +73,8 @@ services:
     networks:
       glympse_net: null
 networks:
-  default:
+  glympse_net:
     external: true
-    name: glympse_net
 ```
 There are two more files that you need to create and save before running the compose file. 
 

content/docs/Installation/install_glympse.md

@@ -12,14 +12,49 @@ UWSGI and NGINX are required for the webui service
 
 The following compose file will enable all services in a single container. This will work but it is possible that the transcoding and transcribing tasks can slow down the webui if you're running on a slower machine. 
 
+If you are going to be running the transcoder or the transcription engine, you will need an Nvidia GPU. To find the device ID run `nvidia_smi` on the system you will be installing the container. 
+This will give you an output that looks like this:
+```
++-----------------------------------------------------------------------------------------+
+| NVIDIA-SMI 565.57.02              Driver Version: 566.03         CUDA Version: 12.7     |
+|-----------------------------------------+------------------------+----------------------+
+| GPU  Name                 Persistence-M | Bus-Id          Disp.A | Volatile Uncorr. ECC |
+| Fan  Temp   Perf          Pwr:Usage/Cap |           Memory-Usage | GPU-Util  Compute M. |
+|                                         |                        |               MIG M. |
+|=========================================+========================+======================|
+|   0  NVIDIA GeForce GTX 1080        On  |   00000000:01:00.0  On |                  N/A |
+| 27%   38C    P8              8W /  180W |     893MiB /   8192MiB |      1%      Default |
+|                                         |                        |                  N/A |
++-----------------------------------------+------------------------+----------------------+
+                                                                                         
++-----------------------------------------------------------------------------------------+
+| Processes:                                                                              |
+|  GPU   GI   CI        PID   Type   Process name                              GPU Memory |
+|        ID   ID                                                               Usage      |
+|=========================================================================================|
+|    0   N/A  N/A        26      G   /Xwayland                                   N/A      |
++-----------------------------------------------------------------------------------------+
+```
+The device id is in the third row, just above the memory:
+```
++========================+
+|   00000000:01:00.0  On |
+|     893MiB /   8192MiB |
+|                        |
++------------------------+
+```
+In this case the device id is: `00000000:01:00.0`
+
+Add this to your compose file. A file that runs all services with a gpu looks like:
+
 ```yaml {filename="compose.yml"}
 services:
-  Glympse:
+  Glympse_net:
     image: git.themainframe.co.uk/josh/glympse
     container_name: Glympse
     restart: unless-stopped
     ports:
-      - 80:80
+      - 8080:80
     environment:
       TZ: Europe/London
       ENABLE_UWSGI: yes
@@ -29,11 +64,45 @@ services:
       ENABLE_MIGRATIONS: yes
       ENABLE_TRANSCRIBER: yes
       ENABLE_TRANSCODER: yes
+      DJANGO_SETTINGS_MODULE: Glympse.settings.production
+      SECRET_KEY: "super_secret_key"
+      SECRET_ADMIN_URL: random_string
+      CSRF_TRUSTED_ORIGINS: http://127.0.0.1
+      ALLOWED_HOSTS: 127.0.0.1
+      ADMINS: admin@glympsevideo.com
+      DOMAIN: glympse.glympsevideo.com
+      SQL_ENGINE: django.db.backends.mysql
+      SQL_DATABASE: glympse
+      SQL_USER: glympse
+      SQL_PASSWORD: insecure_password
+      SQL_HOST: mysql
+      SQL_PORT: 3306
+      EMAIL_HOST: mail.themainframe.co.uk
+      EMAIL_PORT: 587
+      EMAIL_USE_TLS: true
+      EMAIL_HOST_USER: noreply@glympsevideo.com
+      EMAIL_HOST_PASSWORD: insecure_password
+      DEFAULT_FROM_EMAIL: Glympse<glympse@glympsevideo.com>
+      ALLOWED_EMAIL_DOMAINS: glympsevideo.com
+      REDIS_HOST: redis://redis:6379
+      RABBITMQ_URL: amqp://glympse:insecure_password@rabbitmq:5672/glympse
+      ADMIN_USERNAME: hub
+      ADMIN_EMAIL: admin@glympsevideo.com
+      ADMIN_PASSWORD: insecure_password
+      LOG_LEVEL: DEBUG
+      TIMEZONE: Europe/London
+      MICROSOFT_AUTH_CLIENT_ID: None
+      MICROSOFT_AUTH_CLIENT_SECRET: None
+      MICROSOFT_AUTH_TENANT_ID: None
+      MEMCACHED: memcached:11211
+      CUDA_DEVICE: cuda:0
+      DEBUG: "True"
+      REMOTE_WORKER: "False"
+      REMOTE_PRODUCTION: None
     volumes:
       - /opt/glympse/logs:/Glympse/logs
-      - /opt/glympse/.env:/Glympse/config/.env
+      - /media:/media
-      - <Glympse media location>:/media
+      - /rushes:/rushes:ro
-      - <rushes location>:/rushes:ro
     deploy:
       resources:
         reservations:
@@ -43,55 +112,42 @@ services:
                 - 00000000:01:00.0
               capabilities:
                 - gpu
+    networks:
+      glympse_net: null
   memcached:
     image: memcached:latest
     container_name: memcached
     entrypoint: memcached -m 256
     restart: unless-stopped
     networks:
-  default:
+      glympse_net: null
+networks:
+  glympse_net:
     external: true
-    name: glympse_net
 ```
 
+If you are install Glympse on a second system or a system other than where the raw camera files are stored you can use the following to mount the volumes as smb shares:
  
-The following env file is required. You will need to change some of the options to what you specified in the database section of the install. 
+```yaml 
-
+volumes:
-Every line must be in the env file for every container you run regardless of what services are enabled. 
+  rushes:
-
+    driver: local
-```env {filename=".env"}
+    driver_opts:
-DJANGO_SETTINGS_MODULE="Glympse.settings.production"
+      type: cifs
-SECRET_KEY="<generate a long random string>"
+      o: username=<sbm_username>,password=<smb_password>,ro,domain=localhost
-SECRET_ADMIN_URL=<Generate a short random string>
+      device: \\smb\share\path
-CSRF_TRUSTED_ORIGINS=https://"<Glympse domain>"
-ALLOWED_HOSTS="<Glympse Domain>"
-ADMINS='<admin email address>'
-DOMAIN='<Glympse domain>'
-MAX_FIELDS=5000
-SQL_ENGINE="django.db.backends.mysql"
-SQL_DATABASE="glympse"
-SQL_USER="glympse"
-SQL_PASSWORD="<your glympse mysql password>"
-SQL_HOST="mysql"
-SQL_PORT="3306"
-EMAIL_HOST="<mail server>"
-EMAIL_PORT="<mail port>"
-EMAIL_USE_TLS="<mail tls>"
-EMAIL_HOST_USER="<email username>"
-EMAIL_HOST_PASSWORD="<email password>"
-DEFAULT_FROM_EMAIL="Glympse<glympse@example.com>"
-ALLOWED_EMAIL_DOMAINS="<allowed domains for user sign up>"
-REDIS_HOST="redis://redis:6379"
-RABBITMQ_URL="amqp://glympse:<rabbitmq password>@rabbitmq:5672/glympse"
-ADMIN_USERNAME="<admin username>"
-ADMIN_EMAIL="<admin email address>"
-ADMIN_PASSWORD="<default admin password>"
-LOG_LEVEL="INFO"
-TIMEZONE="Europe/London"
-MICROSOFT_AUTH_CLIENT_ID='<client ID for SSO>'
-MICROSOFT_AUTH_CLIENT_SECRET='<client secret for SSO>'
-MICROSOFT_AUTH_TENANT_ID='<tenant ID for SSO>'
-MEMCACHED='memcached:11211'
-CUDA_DEVICE='cuda:0'
-DEBUG=False
 ```
+
+Alternatively you can use a nfs share:
+```yaml
+volumes:
+  rushes:
+    driver_opts:
+      type: nfs
+      o: "addr=<nfs-server-ip>,nolock,soft,rw"
+      device: ":/full/share/path"
+```
+
+You will need to make sure that if you are mounting the raw rushes volume that you mount this as `ro` or read only so Glympse can not make any changes to the raw rushes. 
+
+If you are mounting the glympse mediafiles or logs, you will need to mount this as `rw` or read write so Glympse can create the files. 

content/docs/Installation/services.md

@@ -8,6 +8,9 @@ next: docs/install_glympse
 Glympse is split into multiple services so you can split the workload between multiple machines. 
 
 The available services are as follows:
+* Celery Beat\
+You should only have one of these running across all your containers. This is responsible for managing the scheduled tasks. Without this, the scheduled tasks will not run. For ease, I usually run this in the same container as the webui. 
+
 * WebUI\
   This is the webui front end. The reverse proxy needs to point to the machine that is running this service. It is possible to run more than one frontend for load balancing purposes. 
 

content/docs/Setup/admin_frontend.md

@@ -0,0 +1,78 @@
+---
+title: Glympse Admin
+prev: /docs/setup/admin_frontend
+---
+You can manage most of the admin settings from the front end. When a user is assigned admin permissions or is joined to the "hub" group they will have access to the admin menu on the webUI.
+
+## Dashboard
+Access the dashboard page. This give you an overview of the system. It will show some figures like how many clips are waiting to be transcoded or how many clips have been transcribed. It also shows you all running tasks and will also show who is currently online.
+
+You can also trigger the periodic tasks from the bottom of this page. 
+
+## Logs
+View the system logs. 
+
+## Add Production
+This brings up the add production modal where you can add a production. This is the same interface as pressing the add production button on the home page. 
+
+## Edit Production
+Here you can edit productions.
+#### Production Admin
+This is who is responsible for the production. It's likely that this should be the edit assistant assigned to the production. You can change this here, this person will receive the emails after the production has been scanned. 
+
+#### Cover Image
+Click the image to upload a new thumbnail image for the production. Or reset it. 
+
+#### Active
+An active production will be scanned for new rushes. A deactivated production will still be available to users.
+
+#### Archive
+This will remove the production from being able to be viewed. All files will remain, they will just be hidden. 
+
+#### Export
+This will export a json file containing the database entries for this production that can be archived to another system along with the media files. The media files will have to be manually backed up from your server. Once you have backed up the json file and the media, you can delete the production. 
+
+#### Delete
+This will delete the production and all the clips associated with it. 
+
+## Manage Users
+### Edit Users
+Select a user from the dropdown menu and you can assign the user to a group. You can also deactivate the user which will keep the account but not allow the user to log in. Or you can delete the user which will delete their account completely. 
+
+If the user was created by logging in via SSO, they will still be able to log in once they have been deleted. But they will have no permissions and won't be assigned to a group so will not have access to any productions. 
+
+You can enable the ability for users to scan or start a production transcoder. They will only be able to scan or transcode the productions they have access to. 
+
+Clicking on the number beside their name at the top will enter the impersonation for this user. This is useful if you need to check a user has the correct permissions. 
+
+You can add a local user by clicking the blue + button at the top. 
+
+### Edit Group Permissions
+When a base production is added, a new group of the same name will be created. 
+
+From this page you can select a group and assign productions to it. Users assigned to this group will then be able to access these productions. 
+
+You can add a new group by clicking the blue + button at the top right.
+
+From this page you can 
+## Settings
+This will open the django admin setting page. 
+
+## Send Email
+Here you can send an email to registered users. 
+Either select an existing email draft or click new to create a new one. 
+
+This will take you to the editor page. Set the Subject at the top, then select a date and time to send the email. Not setting this will send immediately. 
+
+Select the recipients of the email and draft the email below. 
+
+The editor is a WYSIWYG editor so the email body will appear exactly as it does in this editor. You can add images and graphics to the email body should you wish. 
+
+Click save and preview. This will show you a copy of what the email will look like when sent. You will be able to either schedule the send or edit the email again after this point. 
+
+Click Delete to delete the email draft. 
+
+## Clear Cache
+This clears the cache of the system. Useful if there have been large database changes. By default the system caches data for around 10 minutes. 
+
+Users may have to force refresh their browser to clear their local cache if the changes aren't appearing for them. 

content/docs/Setup/admin_settings.md

@@ -1,4 +1,69 @@
 ---
-title: Admin Settings
+title: Django Admin Settings
-#next: /docs/Installation/database
+next: /docs/setup/admin_frontend
 ---
+The admin settings page is where you can change almost everything. If it's in the database, it's likely you can make changes here. 
+
+## System Settings
+# Whisper Model
+[See here for more information](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages)\
+Default: small
+
+| Size 	    | Parameters 	| English-only model 	|Multilingual model 	|Required VRAM 	|Relative speed     |
+| --------- | ------------- | --------------------- | --------------------- | ------------- | --------------    |  
+| tiny 	    | 39 M 	        | tiny.en 	            |tiny 	                |   ~1 GB 	    |    ~10x           |
+| base 	    | 74 M 	        | base.en 	            |base 	                |   ~1 GB 	    |    ~7x            |
+| small 	| 244 M 	    | small.en 	            |small 	                |   ~2 GB 	    |    ~4x            |
+| medium 	| 769 M 	    | medium.en 	        |medium 	            |   ~5 GB 	    |    ~2x            |
+| large 	| 1550 M 	    | N/A 	                |large 	                |   ~10 GB 	    |    1x             |
+| turbo 	| 809 M 	    | N/A 	                |turbo 	                |   ~6 GB 	    |    ~8x            |
+
+## Authentication and Authorization
+Here you can manage the advanced settings of the users and Groups. Most of these settings can be changed from the front end without coming into the Django Admin page. 
+
+## Impersonate 
+Here you can view the logs for the impersonation.
+
+## Periodic Tasks. 
+These are created when installed. Should you wish to change the time the tasks run, you would do so in the Periodic Tasks section. 
+
+### Clocked
+These run once at a specific date and time. 
+
+### Cron Tabs
+This is where you can set advanced schedules using cron. [See here for more information about Cron](https://crontab.guru/)
+
+### Intervals
+These will allow you to let a task run at specific intervals, e.g. run once every hour. 
+
+### Periodic Tasks
+This is where you register or change the tasks, To change the schedule, you will need to create the schedule using one of the above options and then select it in this page. 
+
+You can also enable and disable tasks here as well as override the priority of the task. 
+
+## Review
+### Review Files
+This is where you can see all the files that have been uploaded for review. You can retranscode or delete the files from here. 
+
+### Share Links
+Add, edit or delete the share links for files here. 
+
+## Rushes Management
+You can make changes to the metadata of the clips or add or remove the productions here. But most of these tasks can and should be done in the front end.
+
+### Base Productions
+Add or edit the base productions. You can also change the group that the Base Production is assigned to. 
+
+### Production
+Here you can make changes to the production such as the name, friendly name, filepath etc. You can also trigger some tasks from this page such as the file scan or the transcoder. 
+
+### clips
+Here you can see and edit all the metadata for the clips in the Glympse database. 
+
+
+## Transcribe
+### Clips for Transcription
+Here you can see all of the clips that have been sent to the transcription engine. You can trigger tasks such as re-transcribe or delete the files from here. 
+
+
+

content/user_docs/Edit_Metadata/_index.md

@@ -0,0 +1,15 @@
+---
+title: Metadata
+type: docs
+prev: /user_docs/
+weight: 2
+---
+It is possible to edit some of the metadata for the clips within Glympse. 
+
+Any metadata changes apply only to the Glympse database and are not carried over to the clips themselves. 
+
+
+To edit the metadata of the clips, click "Edit Clips" in the top right. This will look like the home page where you can select your production. 
+Click the Edit button to edit the clip metadata. 
+
+![Edit Metadata](/images/edit_metadata_select.png)

content/user_docs/Edit_Metadata/editing_metadata.md

@@ -0,0 +1,26 @@
+---
+title: Editing Metadata
+type: docs
+prev: /user_docs/
+#next: /user_docs/Edit_Metadata/editing_metadata
+---
+When you click Edit on the metadata page you will be taken to the edit page. This shows a table with all the clips for that production. You can see whether a clip has been transcoded, is marked as hidden or edit the metadata of the clip(s)
+
+![Edit Metadata](/images/edit_metadata.png)
+
+There are limited options for editing the metadata. You can edit only the roll, the date and the shooter aswell as hide or unhide a clip. 
+
+To edit a clip select it by checking the checkbox of the clip row. At the bottom of the table you can enter a new roll/date/shooter then click save to save the edits. 
+
+Whatever you entered in all three boxes will be applied to the selected clips. Leave the box empty to leave the current details unchanged. 
+
+You can also hide/unhide clips by checking the hide checkbox. As soon as you click the checkbox it will be immediately hidden. It is possible that the clips may still appear until the cache has ben flushed. This process can take 10-15 minutes.
+
+
+From this page you can also send multiple clips to the transcription engine. 
+
+Select the clips by checking the checkbox and click transcribe. This w3ill send the selected clips to be transcribed. 
+
+You can also delete clips from the Glympse database. 
+
+Glympse has read only access to the raw camera files, by deleting clips from Glympse, the original camera files will be unaffected. 

content/user_docs/Watching Clips/_index.md

@@ -0,0 +1,24 @@
+---
+title: Watching Clips
+type: docs
+prev: /user_docs/
+next: /user_docs/watch
+weight: 1
+---
+
+![Home Page](/images/home.png)
+Once You have been added to a production(s). You will see all your available productions on your home page. Under the thumbnail for each production you will see a list of buttons. The fist will let you view all the rushes from every shooter. 
+
+![All Rushes](/images/all_rushes.png)
+
+Under that you will see a list of the shooters from that project. Clicking on these will allow you to filter the production by that shooter. 
+
+If we were to click on John Snow from either the home page or at the top of the rushes page. We will filter the rushes to show only those shot by John Snow. 
+
+![Shooter Filter](/images/shooter_filter.png)
+
+At the top of the page, you can also click on the name of the shooter to filter the clips. Clicking on the shooter will only return results shot by the selected shooter. Clicking All or Reset will show all the rushes again. 
+
+In the search bar, you can search for a card or date. The results will be filtered live as you type. 
+
+Once you select a card, you'll be taken to the video player screen. 

content/user_docs/Watching Clips/add_production.md

@@ -0,0 +1,40 @@
+---
+title: Adding A Production
+type: docs
+prev: /user_docs/
+weight: 3
+---
+To add a production click the "Add Production" button in the top right of the home page. 
+
+This will bring up the dialogue to add a new production. 
+![Add Production Modal](/images/add_production.png)
+A production consists of two parts. The Base Production and the Production. 
+
+For example your Base Production may be "Game of Thrones" then the Production could be "Game of Thrones Series 1"
+
+## Base Production
+Select the Base Production, if it doesn't exist create it by clicking the button next to the select dropdown. 
+Enter the new name of your production and click submit. 
+![Add Production Base](/images/add_base.png)
+The name you entered will be automatically selected. 
+
+## Production Series
+Enter the series of the production you are adding. This must be an integer. 
+
+## Friendly Name
+Enter a short friendly name for the series. This is what will appear on the default thumbnail. In this example we will enter `GOTS1`
+
+## Select the location of the camera rushes.
+Click on a directory to open it and select it by clicking the radio check mark on the left. 
+![Select Series](/images/series_select.png)
+
+## Priority
+Most productions can be left as the default of 20. But if you have a smaller production or one where the transcodes need to be run before others you can change the priority here. 0 = lowest priority 100 = highest priority. 
+
+## Production Owner
+This is who will be responsible for the production. They will get the emails to say that the production has been scanned etc. This will usually be the edit assistant assigned to the project. The user must exist in the Glympse system. 
+
+If left empty, this will default to the admin user. 
+
+Click submit and the production will be added to Glympse and the Processing engine will start scanning for new clips.
+![production Added](/images/production_added.png)

content/user_docs/Watching Clips/user_settings.md

@@ -0,0 +1,30 @@
+---
+title: User Settings
+type: docs
+prev: /user_docs/
+weight: 4
+---
+From the User Settings menu you can change some personal settings. 
+![User Settings](/images/user_settings.png)
+## Auto Add/Remove Tags
+When checked, this will automatically add or remove tags on any related clips. When unchecked this, any tags you add or remove, will only be apply to the clips you have selected. 
+
+## Show Timecode Heading
+This enables/disables the timecode box in the video player. Is is enabled by default, should you wish to disable it, you would do so here. 
+
+## Timecode Size
+Default: 16
+
+You can change the font size for the timecode box here. Increase to make the timecode larger, decrease to make it smaller. 
+
+## Reset Timecode Position
+It is possible that the timecode box may disappear off the ege of the video player. Especially if you use multiple devices with different resolution screens. If that happens, you can reset it to the top left corner here. 
+
+## Auto Expand related clips
+This will automatically expand the related clips accordion oin the right next to the player. If it is enabled, the related clips will be shown automatically. If disabled you would need to manually open the accordion to display them.
+
+## Marker Colour
+Change the colour of your markers, this only really applies to the Review section. 
+
+## Receive Admin Emails
+If you are set as a production owner, this enables/disables the email updates. 

content/user_docs/Watching Clips/watch.md

@@ -0,0 +1,126 @@
+---
+title: Watching clips
+type: docs
+prev: /user_docs/watch
+weight: 2
+---
+
+![Watch Clips](/images/watch_clips.png)
+This is where you will watch through the clips in Glympse. 
+
+When the page loads, it will automatically load the first clip into the player. To start playing you can press the big play button in the centre. 
+
+
+
+### The video Player
+
+#### Timecode
+Glympse uses the timecode from the media files. This is so that it matches the timecode that your editor sees within Avid or their NLE of choice. 
+
+*It is possible that the timecode in Glympse may be a frame off, this is because the timecodes must be calculated rather than read from the file. It will never be more that one frame off the timecode in the NLE.*
+
+
+The timecode of the clip is displayed in two places. The seek bar:
+![Timecode 1](/images/timecode1.png)
+
+And there is a timecode box in the top left:
+![Timecode 2](/images/timecode2.png)
+
+This timecode box can be moved anywhere in the player window by dragging it to where you'd like it to be. You can reset the position of the timecode or disable the timecode box using the [user settings menu.](/user_docs/user_settings)
+
+
+#### Audio Selection
+For clips that have more than one track of audio, you can select the track to play back by clicking on the headphone icon on the playbar and selecting the audio track. Glympse by default creates a full mix of all the audio channels and plays this by default. 
+![Audio Tracks](/images/audio_select.png)
+
+#### Theatre Mode
+![Theatre Mode](/images/theatre_mode.png)
+Clicking the theatre mode button will expand the player to take 100% the width of the browser window. Clicking the theatre mode button again will return the player back to its normal size. 
+
+#### Full Screen
+Click this button for full screen playback
+![Full Screen](/images/full_screen.png)
+
+#### Rotate
+Some clips like GoPro files can be the wrong orientation. Click the rotate button to rotate the clip by 180°
+![Rotate](/images/rotate.png)
+
+Click the restore rotate to return the clip to its original orientation. 
+![Restore Rotate](/images/restore_rotate.png)
+
+#### Keyboard shortcuts
+
+When on this page there are a number of keyboard shortcuts you can use. 
+J, K, L are shuttle controls to speed up or change the direction of play. You may have to click in the player window to enable these controls. Holding the Shift Key will also increase the amount the play is sped up or slowed down. 
+
+M will add a marker at the current time of the clip. Markers will appear for everyone who has access to the production. 
+
+### Selecting Clips
+You can select the clip you'd like to view from the table at the bottom of the screen. Click the title of the clip to load it into the player. 
+
+You can also navigate through the clips by pressing the Next/Prev buttons at the bottom of the player. This will load the next or previous clip. 
+
+The title of the currently playing clip is shown at the bottom of the player and the middle of the menu bar at the top. 
+
+### Related Clips
+When clips are loaded into Glympse, the system will scan for the start timecode and the end timecode of a clip. This allows it to show all the related clips of the clip you are playing. The related clips box onthe right of the player will update whenever the source of the video player changes. You can automatically hide or show the related clips dropdown using the [user settings menu.](/user_docs/user_settings)
+
+In this example the clip being played belongs to the Main camera and there are two GoPro cameras that have clips with overlapping timecodes. 
+
+![Related](/images/related.png)
+
+Clicking on the title of these related clips will play it in the current page, allowing you to quickly view clips from the other cameras. When you're viewing a related clip, the title in the menu bar and below the player will change showing you that it's playing a related clip then it will list the card followed by the clip title. 
+![Related](/images/related_clip.png)
+As well as this, the prev/next buttons will disappear from below the player. You can select the next related clip by clicking on the clip title or you can return to the original clip by selecting it in the table at the bottom again. This will re-enable the next prev buttons and you can resume watching the camera clips as normal. 
+
+You can also navigate to any related cards from the related menu in the manu bar. This will show you camera cards from the same camera operator shot on the same day. 
+
+### Markers and Tags
+You can add markers or tags to any clip within Glympse. 
+
+#### Markers
+Markers allow you to mark a specific place in a clip. They will be displayed in the marker window next to the player and clicking on them will take you to the correct position in the clip. 
+
+Markers are shown to everyone who has access to the clip. 
+
+#### Tags
+Tags are to tag an entire clip. You can tag more than one clip at a time. There is also a setting in the user settings menu that will automatically add the tags to any related clips. 
+
+Tags are available to everyone who has access to the clips. 
+
+
+## Menu Bar
+![Menu](/images/menu.png)
+The menu bar may show different options depending on what permissions you have. For example, the Download button will only appear if you have been give download permission for your production. 
+
+### File
+From the file menu you can send a clip to be transcribed, edit the metadata of the card, submit the card for re-transcode or report issues with the card. 
+
+#### Transcribe
+Select the clip or clips you would like to transcribe by checking the box in the table and click file then transcribe. This will send the selected clip(s) to the transcription engine. You can learn more about how this works [here.](/user_docs/transcription)
+
+#### Edit metadata
+From this menu you can change some of the metadata for the card. Anything you change here will be applied to every clip in the card. 
+
+You can change the date, the card name, or the shooter. You can also hide the card which will stop it from showing on the rushes page. Anyone with a link to the card would still be able to access the clips. This will *only* stop the card from appearing in the rushes page. Users with access to the production can also unhide any card from the metadata edit pages. 
+
+#### Request Retranscode
+This will send the entire card back through the transcode engine. It allows you to report any issues with the card and manually submit the clips to the transcoder. The transcode will only work if the original clips are still available. 
+
+#### Report Issues
+This allows you to report issues with the current card. But this option will not automatically retranscode the clips. They would need to be manually transcoded by the admin team. 
+
+### Related
+This will show any cards that were shot by the same camera operator on the same day as the current card. Clicking one of these will take you load that current card. 
+
+### Download
+If you have been given the download permissions for your production, you can download the original clip by selecting the clips from the table with the checkbox and clicking download. These files can be very large and may take a long time to download. 
+
+### Help
+This will open these help pages. 
+
+### Settings
+This will open the user settings menu. [Click here to learn more.](/user_docs/user_settings)
+
+
+In the centre of the menu bar, the title of the currently loaded clip will be displayed. 

content/user_docs/_index.md

@@ -1,18 +1,8 @@
 ---
 title: User Documentation
-next: first-page
+next: /user_docs/navigation
 ---
 
-This is a demo of the theme's documentation layout.
+Welcome to the user documentation of Glympse. 
 
-## Hello, World!
+Glympse is designed to be as intuitive as possible, so hopefully you won't need to read this but its here if you need. 
-
-```go {filename="main.go"}
-package main
-
-import "fmt"
-
-func main() {
-    fmt.Println("Hello, World!")
-}
-```