Skip to content

jcapellman/elabftw

 
 

Repository files navigation

elabftw logo

###Official website | Live demo

Scrutinizer Code Quality Build Status

Description

eLabFTW is an electronic lab notebook manager for research teams. It also features a database where you can store any kind of objects (think antibodies, plasmids, cell lines, boxes, etc…) It is accessed via the browser by the users. Several research teams can be hosted on the same install, so eLabFTW can be installed at the institute level and host everyone at the same place (this is what is done at Institut Curie and in several other research centers across the globe.

  • Tired of that shared excel file for your antibodies or plasmids ?

  • Want to be able to search in your past experiments as easily as you'd do it on google ?

  • Want an electronic lab notebook that lets you timestamp legally your experiments ?

  • Then you are at the right place !

eLabFTW is designed to be installed on a server, and people from the team would just log into it from their browser. Don't have a server ? That's okay, you can use an old computer with 1 Go of RAM and an old CPU, it's more than enough. Just install a recent GNU/Linux distribution on it and plug it to the intranet.

Installation

The legendary four steps installation instructions (for advanced users)

Install on your computer (Mac OS X only)

Mac OS X Install locally on Mac

If you want to install it locally on Windows, have a look at Boot2Docker and the docker repo.

Install on a digitalocean's drop (easiest/quickest method)

With this method, you can have a running elabftw server in no time. You need to purchase a drop from DigitalOcean.com. It starts at 5$/month. This setup is enough to run eLabFTW for a team or more. And it's very easy to install, all is automatic!
Install eLabFTW on a drop

Install in a docker container

Docker
If you know Docker already and want to use a dockerized elabftw, please see this repo.

Install on a GNU/Linux or BSD server

Gnu/Linux Beastie

Please refer to your distribution's documentation to install :

  • a webserver (like nginx, Apache, lighttpd or cherokee)
  • php version > 5.4 with the following extensions : gettext, gd, openssl, hash, curl
  • mysql version > 5.5
  • git

If you don't know how to do that, have a look at installing eLabFTW on a cheap server (drop).

I wouldn't recommend HHVM because Gettext support is not here yet (see this issue).

Getting the files

The first part is to get the files composing elabftw on your server, with git.

Alternatively, you can download the latest release from this page as a zip archive or a tarball.

Connect to your server with SSH

ssh user@12.34.56.78

Cd to the public directory where you want eLabFTW to be installed

(can be /var/www, ~/public_html, or any folder you'd like, as long as the webserver is configured properly, in doubt use /var/www)

$ cd /var/www
# make the directory writable by your user (if it's not already the case)
$ sudo chown `whoami`:`whoami` .

Note the . at the end that means current folder.

Get latest stable version via git :

$ git clone --depth 1 https://github.com/elabftw/elabftw.git

(this will create a folder elabftw) The --depth 1 option is to avoid downloading the whole history.

If you cannot connect, try exporting your proxy settings in your shell like so :

$ export https_proxy="proxy.example.com:3128"

If you still cannot connect, tell git your proxy :

$ git config --global http.proxy http://proxy.example.com:8080

Alternatively, you can download a stable version.

But git will allow for easier updates (and they are frequent !).

SQL part

The second part is putting the database in place.

Command line way (graphical way below)

# first we connect to mysql
$ mysql -u root -p
# we create the database (note the ; at the end !)
mysql> create database elabftw;
# we create the user that will connect to the database.
mysql> grant usage on *.* to elabftw@localhost identified by 'YOUR_PASSWORD';
# we give all rights to this user on this database
mysql> grant all privileges on elabftw.* to elabftw@localhost;
mysql> exit

You will be asked for the password you put after identified by three lines above.

*<- Ignore this (it's to fix a markdown syntax highlighting problem)

Graphical way with phpmyadmin

You need to install the package phpmyadmin if it's not already done.

Note: it is not recommended to have phpmyadmin installed on a production server (for security reasons).

$ sudo apt-get install phpmyadmin

Now you will connect to the phpmyadmin panel from your browser on your computer. Type the IP address of the server followed by /phpmyadmin.

Example : https://12.34.56.78/phpmyadmin

Login with the root user on PhpMyAdmin panel (use the password you setup for mysql root user).

Create a user elabftw with all rights on the database elabftw

Now click the Users tab and click add user.

Do like this :

phpmyadmin add user

Final step

Finally, point your browser to the install folder (install/) and read onscreen instructions.

For example : https://12.34.56.78/elabftw/install


Post install things to do

You should read this page to finish your install (configure email, backup, etc…).


Please report bugs on github.

~Thank you for using eLabFTW :)

About

Lab manager, experiment notebook, database for research labs

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 73.6%
  • PHP 13.9%
  • CSS 11.6%
  • HTML 0.8%
  • Shell 0.1%
  • Makefile 0.0%