<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation of labfolder — Labfolder at FHI 1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Groups, ownership and sharing in labfolder" href="groups.html" />
<link rel="prev" title="Welcome to elog2labfolder’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="installation-of-labfolder">
<h1>Installation of labfolder<a class="headerlink" href="#installation-of-labfolder" title="Permalink to this headline">¶</a></h1>
<p>Labfolder is easy to install. Follow the instructions given in the <em>labfolder Installation Manual</em>. The broad steps are: <strong>install MySQL, docker and labolder; configure labfolder via the server.cnf file</strong>. This labfolder config file could look like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># Network settings
DEFAULT_HTTP_PROTOCOL=https://
DEFAULT_DOMAIN=labfolder.rz-berlin.mpg.de
# JDBC Properties
JDBC_SERVER_TIMEZONE=Europe/Berlin
JDBC_DATABASE_URL=jdbc:mysql://localhost:3306/labfolder?useUnicode=true&characterEncoding=UTF-8
JDBC_USERNAME=labfolder
JDBC_PASSWORD=fhilab
JDBC_SCHEMA_NAME=labfolder
#REMOVE_ABANDONED_TIMEOUT=60
# Mail client properties
MAIL_STARTTLS=false
MAIL_AUTHENTICATION_ENABLE=false
MAIL_HOST=mail.fhi-berlin.mpg.de
MAIL_PORT=25
#MAIL_USERNAME=
#MAIL_PASSWORD=
MAIL_EMAIL=ppb@fhi-berlin.mpg.de
# Server Event logging
LOG_TO_FILE=true
#Maximum upload file size
FILEUPLOAD_MAXUPLOADSIZE=25000000
# User and group control
DEFAULT_GROUP_SIZE=50
DEFAULT_GROUP_TYPE_MAXI=true
DEFAULT_USER_STORAGE=3221225472
FEATURE_GLOBAL_PREVENT_DELETE_CONTENT=false
# Terms and Privacy links
TERMS_OF_USE_LINK=https://www.labfolder.com/terms-external-servers/
PRIVACY_LINK=https://www.labfolder.com/privacy-external-servers/
# LDAP Authentication
FEATURE_LDAP_AUTHENTICATION=true
LDAP_URL=ldap://ldap.rz-berlin.mpg.de:389
LDAP_BASE=ou=people,dc=ppb,dc=rz-berlin,dc=mpg,dc=de
#LDAP_SERVER_TYPE=
LDAP_USER_DN=cn=pwCheck,dc=rz-berlin,dc=mpg,dc=de
LDAP_PASSWORD=ProstetnikVogonJeltz
#LDAP_ANONYMOUS_READ_ONLY=
LDAP_USER_DN_PATTERNS=uid={0}
#LDAP_IS_TLS_ENABLED=
#LDAP_IS_ATTRIBUTE_SEARCH_ENABLED=
#LDAP_ATTRIBUTE_SEARCH_NAME=
# Usage monitoring
ACTIVE_USER_REPORT_USE_DEFAULT_MAIL_CLIENT=true
CUSTOMER_IDENTIFIER='Fritz-Haber-Institut'
# Mendeley
FEATURE_MENDELEY=false
#MENDELEY_CLIENT_ID=
#MENDELEY_CLIENT_SECRET=
#MENDELEY_CLIENT_CALLBACKURL=http://localhost:9091/eln/mendeley/oauthCallback
# Dropbox
FEATURE_DROPBOX=false
#DROPBOX_CONSUMER_KEY=
#DROPBOX_CONSUMER_SECRET=
# Figshare
FEATURE_FIGSHARE=false
# XHTML Export
FEATURE_XHTML_EXPORT=true
EXPORT_DOCUMENT_REPOSITORY_TYPE=fileSystem
</pre></div>
</div>
<p>The configuration is explained in detail in the installation manual. Now, <strong>create the labfolder database and run labfolder</strong> (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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>labfolder@lf:~$ sudo apt-get install build-essential
labfolder@lf:~$ sudo apt install apache2
labfolder@lf:~$ sudo a2enmod proxy proxy_ajp proxy_http rewrite deflate headers proxy_balancer proxy_connect proxy_html xml2enc
labfolder@lf:~$ sudo a2enmod ssl
### Use certificates from e.g. let's encrypt. Please see below for more information.
### create /etc/apache2/sites-available/labfolder.conf with virtual hosts for http and https:
labfolder@lf:~$ sudo a2ensite labfolder.conf
labfolder@lf:~$ sudo a2dissite 000-default.conf
labfolder@lf:~$ sudo service apache2 restart
</pre></div>
</div>
<p>To get SSL certificates from letsencrypt is quite straight forward. For example this guide shows how to set up SSL certificates:</p>
<p><a class="reference external" href="https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04">https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04</a></p>
<p>The Apache labfolder config file could look like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">VirtualHost</span> <span class="o">*</span><span class="p">:</span><span class="mi">80</span><span class="o">></span>
<span class="n">ErrorLog</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">apache2</span><span class="o">/</span><span class="n">error</span><span class="o">.</span><span class="n">log</span>
<span class="n">LogLevel</span> <span class="n">warn</span>
<span class="n">ServerName</span> <span class="n">labfolder</span><span class="o">.</span><span class="n">rz</span><span class="o">-</span><span class="n">berlin</span><span class="o">.</span><span class="n">mpg</span><span class="o">.</span><span class="n">de</span>
<span class="n">Redirect</span> <span class="o">/</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">labfolder</span><span class="o">.</span><span class="n">rz</span><span class="o">-</span><span class="n">berlin</span><span class="o">.</span><span class="n">mpg</span><span class="o">.</span><span class="n">de</span><span class="o">/</span>
<span class="o"></</span><span class="n">VirtualHost</span><span class="o">></span>
<span class="o"><</span><span class="n">VirtualHost</span> <span class="o">*</span><span class="p">:</span><span class="mi">443</span><span class="o">></span>
<span class="n">ErrorLog</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">apache2</span><span class="o">/</span><span class="n">error</span><span class="o">.</span><span class="n">log</span>
<span class="n">LogLevel</span> <span class="n">warn</span>
<span class="n">ServerName</span> <span class="n">labfolder</span><span class="o">.</span><span class="n">rz</span><span class="o">-</span><span class="n">berlin</span><span class="o">.</span><span class="n">mpg</span><span class="o">.</span><span class="n">de</span>
<span class="n">SSLEngine</span> <span class="n">On</span>
<span class="n">SSLCertificateFile</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">letsencrypt</span><span class="o">/</span><span class="n">live</span><span class="o">/</span><span class="n">labfolder</span><span class="o">.</span><span class="n">rz</span><span class="o">-</span><span class="n">berlin</span><span class="o">.</span><span class="n">mpg</span><span class="o">.</span><span class="n">de</span><span class="o">/</span><span class="n">fullchain</span><span class="o">.</span><span class="n">pem</span>
<span class="n">SSLCertificateKeyFile</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">letsencrypt</span><span class="o">/</span><span class="n">live</span><span class="o">/</span><span class="n">labfolder</span><span class="o">.</span><span class="n">rz</span><span class="o">-</span><span class="n">berlin</span><span class="o">.</span><span class="n">mpg</span><span class="o">.</span><span class="n">de</span><span class="o">/</span><span class="n">privkey</span><span class="o">.</span><span class="n">pem</span>
<span class="n">ProxyPass</span> <span class="o">/</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">141.14</span><span class="o">.</span><span class="mf">138.230</span><span class="p">:</span><span class="mi">9091</span><span class="o">/</span>
<span class="n">ProxyPassReverse</span> <span class="o">/</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">141.14</span><span class="o">.</span><span class="mf">138.230</span><span class="p">:</span><span class="mi">9091</span><span class="o">/</span>
<span class="o"></</span><span class="n">VirtualHost</span><span class="o">></span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to elog2labfolder’s documentation!</a></li>
<li>Next: <a href="groups.html" title="next chapter">Groups, ownership and sharing in labfolder</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2018, Stefan Weiher.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
<a href="_sources/installation.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>