update nas target, documentation

config/README.md

@@ -0,0 +1,8 @@
+## Configuration: example
+The files inside this directory (not the ones in `env/`) are a sample of the required configuration.
+
+Please create a copy of these files under `<location of downloads>/config/...`.
+
+> Note:
+>
+> Some of the fields are blank, please fill them in as needed.

config/db.config.ini

@@ -0,0 +1,7 @@
+[DATABASE]
+db_name: coss_archiving
+user_name: ****************
+password: ****************
+
+## user_name: ca_ro
+## password: #TK5cLxA^YyoxWjR6

config/env/debug

@@ -0,0 +1,10 @@
+# Runs in a debugging mode, does not launch anything at all but starts a bash process
+
+export CONTAINER_DATA=/mnt/media/@Bulk/COSS/Downloads/coss_archiving
+export UNAME=remy
+export U_ID=1000
+
+export DEBUG=true
+export HEADFULL=true
+export CODE=./
+export ENTRYPOINT=/bin/bash

config/env/production

@@ -0,0 +1,7 @@
+# Runs on the main slack channel with the full worker setup. If nothing funky has occured, reducedfetch is a speedup
+
+CONTAINER_DATA=/mnt/media/@Bulk/COSS/Downloads/coss_archiving
+
+export UNAME=remy
+export U_ID=1000
+export DEBUG=false

config/nas_login.config

@@ -0,0 +1,3 @@
+user=remoll
+domain=D
+password=****************

config/nas_sync.config

@@ -0,0 +1,12 @@
+settings {
+   logfile    = "/tmp/lsyncd.log",
+   statusFile = "/tmp/lsyncd.status",
+   nodaemon   = true,
+}
+
+sync {
+   default.rsync,
+   source = "/sync/local_files",
+   target = "/sync/remote_files",
+   init = false,
+}

config/news_fetch.config.ini

@@ -0,0 +1,31 @@
+[MAIL]
+smtp_server: smtp.ethz.ch
+port: 587
+sender: ****************
+recipient: ****************
+uname: ****************
+password: ****************
+
+
+[SLACK]
+bot_id: U02MR1R8UJH
+archive_id: C02MM7YG1V4
+debug_id: C02NM2H9J5Q
+api_wait_time: 90
+auth_token: ****************
+app_token: ****************
+
+
+[DATABASE]
+download_db_debug: /app/containerdata/debug/downloads.db
+db_printout: /app/containerdata/backups
+
+
+[DOWNLOADS]
+local_storage_path: /app/containerdata/files
+debug_storage_path: /app/containerdata/debug/
+default_download_path: /app/containerdata/tmp
+remote_storage_path: /helbing_support/Archiving-Pipeline
+browser_profile_path: /app/containerdata/dependencies/news_fetch.profile
+# please keep this exact name
+browser_print_delay: 3

config/vpn.config

@@ -0,0 +1,4 @@
+OPENCONNECT_URL=sslvpn.ethz.ch/student-net
+OPENCONNECT_USER=****************
+OPENCONNECT_PASSWORD=****************
+OPENCONNECT_OPTIONS=--authgroup student-net