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