elog2labfolder/installation.rst
author weiher
Thu, 11 Jan 2018 12:10:42 +0100
changeset 3 b71be85a294c
permissions -rw-r--r--
Initial commit of labfolder at FHI documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     1
Installation of labfolder
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     2
=========================
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     3
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     4
Labfolder is easy to install. Follow the instructions given in the *labfolder Installation Manual*. The broad steps are: **install MySQL, docker and labolder; configure labfolder via the server.cnf file**. This labfolder config file could look like this::
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     5
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     6
	# Network settings
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     7
	DEFAULT_HTTP_PROTOCOL=https://
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     8
	DEFAULT_DOMAIN=labfolder.rz-berlin.mpg.de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     9
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    10
	# JDBC Properties
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    11
	JDBC_SERVER_TIMEZONE=Europe/Berlin
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    12
	JDBC_DATABASE_URL=jdbc:mysql://localhost:3306/labfolder?useUnicode=true&characterEncoding=UTF-8
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    13
	JDBC_USERNAME=labfolder
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    14
	JDBC_PASSWORD=fhilab
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    15
	JDBC_SCHEMA_NAME=labfolder
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    16
	#REMOVE_ABANDONED_TIMEOUT=60
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    17
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    18
	# Mail client properties
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    19
	MAIL_STARTTLS=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    20
	MAIL_AUTHENTICATION_ENABLE=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    21
	MAIL_HOST=mail.fhi-berlin.mpg.de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    22
	MAIL_PORT=25
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    23
	#MAIL_USERNAME=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    24
	#MAIL_PASSWORD=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    25
	MAIL_EMAIL=ppb@fhi-berlin.mpg.de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    26
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    27
	# Server Event logging
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    28
	LOG_TO_FILE=true
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    29
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    30
	#Maximum upload file size
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    31
	FILEUPLOAD_MAXUPLOADSIZE=25000000
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    32
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    33
	# User and group control
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    34
	DEFAULT_GROUP_SIZE=50
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    35
	DEFAULT_GROUP_TYPE_MAXI=true
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    36
	DEFAULT_USER_STORAGE=3221225472
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    37
	FEATURE_GLOBAL_PREVENT_DELETE_CONTENT=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    38
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    39
	# Terms and Privacy links
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    40
	TERMS_OF_USE_LINK=https://www.labfolder.com/terms-external-servers/
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    41
	PRIVACY_LINK=https://www.labfolder.com/privacy-external-servers/
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    42
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    43
	# LDAP Authentication
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    44
	FEATURE_LDAP_AUTHENTICATION=true
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    45
	LDAP_URL=ldap://ldap.rz-berlin.mpg.de:389
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    46
	LDAP_BASE=ou=people,dc=ppb,dc=rz-berlin,dc=mpg,dc=de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    47
	#LDAP_SERVER_TYPE=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    48
	LDAP_USER_DN=cn=pwCheck,dc=rz-berlin,dc=mpg,dc=de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    49
	LDAP_PASSWORD=ProstetnikVogonJeltz
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    50
	#LDAP_ANONYMOUS_READ_ONLY=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    51
	LDAP_USER_DN_PATTERNS=uid={0}
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    52
	#LDAP_IS_TLS_ENABLED=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    53
	#LDAP_IS_ATTRIBUTE_SEARCH_ENABLED=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    54
	#LDAP_ATTRIBUTE_SEARCH_NAME=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    55
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    56
	# Usage monitoring
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    57
	ACTIVE_USER_REPORT_USE_DEFAULT_MAIL_CLIENT=true
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    58
	CUSTOMER_IDENTIFIER='Fritz-Haber-Institut'
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    59
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    60
	# Mendeley
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    61
	FEATURE_MENDELEY=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    62
	#MENDELEY_CLIENT_ID=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    63
	#MENDELEY_CLIENT_SECRET=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    64
	#MENDELEY_CLIENT_CALLBACKURL=http://localhost:9091/eln/mendeley/oauthCallback
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    65
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    66
	# Dropbox
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    67
	FEATURE_DROPBOX=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    68
	#DROPBOX_CONSUMER_KEY=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    69
	#DROPBOX_CONSUMER_SECRET=
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    70
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    71
	# Figshare
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    72
	FEATURE_FIGSHARE=false
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    73
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    74
	# XHTML Export
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    75
	FEATURE_XHTML_EXPORT=true
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    76
	EXPORT_DOCUMENT_REPOSITORY_TYPE=fileSystem
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    77
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    78
The configuration is explained in detail in the installation manual. Now, **create the labfolder database and run labfolder** (see the manual for details). Additionally, you could install Apache and set it up as a reverse proxy in order to make labfolder only available through https. The exact steps are::
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    79
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    80
	labfolder@lf:~$ sudo apt-get install build-essential
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    81
	labfolder@lf:~$ sudo apt install apache2
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    82
	labfolder@lf:~$ sudo a2enmod proxy proxy_ajp proxy_http rewrite deflate headers proxy_balancer proxy_connect proxy_html xml2enc
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    83
	labfolder@lf:~$ sudo a2enmod ssl
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    84
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    85
	### Use certificates from e.g. let's encrypt. Please see below for more information.
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    86
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    87
	### create /etc/apache2/sites-available/labfolder.conf with virtual hosts for http and https:
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    88
	labfolder@lf:~$ sudo a2ensite labfolder.conf
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    89
	labfolder@lf:~$ sudo a2dissite 000-default.conf
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    90
	labfolder@lf:~$ sudo service apache2 restart
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    91
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    92
To get SSL certificates from letsencrypt is quite straight forward. For example this guide shows how to set up SSL certificates:
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    93
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    94
https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    95
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    96
The Apache labfolder config file could look like this::
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    97
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    98
	<VirtualHost *:80>
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    99
	    ErrorLog /var/log/apache2/error.log
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   100
	    LogLevel warn
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   101
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   102
	    ServerName labfolder.rz-berlin.mpg.de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   103
	    Redirect / https://labfolder.rz-berlin.mpg.de/
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   104
	</VirtualHost>
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   105
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   106
	<VirtualHost *:443>
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   107
	    ErrorLog /var/log/apache2/error.log
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   108
	    LogLevel warn
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   109
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   110
	    ServerName labfolder.rz-berlin.mpg.de
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   111
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   112
	    SSLEngine On
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   113
	    SSLCertificateFile /etc/letsencrypt/live/labfolder.rz-berlin.mpg.de/fullchain.pem
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   114
	    SSLCertificateKeyFile /etc/letsencrypt/live/labfolder.rz-berlin.mpg.de/privkey.pem
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   115
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   116
	    ProxyPass / http://141.14.138.230:9091/
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   117
	    ProxyPassReverse / http://141.14.138.230:9091/
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   118
	</VirtualHost>
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   119
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   120
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   121
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
   122