Skip to content

mpg-age-bioinformatics/flaski

Repository files navigation

GitHub tag (latest by date) DOI Docker Image CI nightly Docker Image CI latest Docker Image CI Production

Flaski

Flaski is a myapp based collection of web apps for data analysis and visualization in life sciences.

flaski

Flaski provides:

  • interactive data analysis
  • user level authentication
  • Apps as plugins
  • session management
  • server storage
  • Graphic User Interface to Programmatic Interface
  • App2App communication
  • server based
  • background jobs
  • access to databases
  • usage statistics
  • on-the-fly error reporting
  • scalable
  • continuous delivery
  • full stack ready
  • multiplatform: amd64, arm64, and * aarch64*

Flaski can be used for free on https://flaski.age.mpg.de.

Check our how-to videos on YouTube.

Information on how to deploy Flaski on your own servers can be found in DEPLOYING.md and on Google Kubernetes Engine in kubernetes.

For Graphical User Interface to Programmatic Interface exchanges please install the pyflaski companion package.

Flaski sessions are versioned and you can check the respective version of any saved session here. For reproducting plots done with previous Flaski versions please use the pyflaski companion package.

If you are looking to contribute to Flaski please check CONTRIBUTING.md.

Issues: https://github.com/mpg-age-bioinformatics/flaski/issues.

Please check our CODE_OF_CONDUCT.md before doing any contribution or opening an issue.


Local installation

Feel free to contact us if you would like to deploy Flaski at your institution or if you would like to contribute to Flaski.

mkdir -p ~/flaski_data/backup/stats ~/flaski_data/backup/users_data ~/flaski_data/backup/mariadb
git clone [email protected]:mpg-age-bioinformatics/flaski.git
cd flaski
cat << EOF > .env
MYSQL_PASSWORD=$(openssl rand -base64 20)
MYSQL_ROOT_PASSWORD=$(openssl rand -base64 20)
REDIS_PASSWORD=$(openssl rand -base64 20)
SECRET_KEY=$(openssl rand -base64 20)
EOF
docker-compose -f production-compose.yml up -d

Email logging:

docker-compose -f production-compose.yml exec server3 python3 -m smtpd -n -c DebuggingServer localhost:8025

Flaski is now accessible under https://flaski.localhost. Depending on your local machine, it might take a few seconds until the server is up and running. You might need to edit your /etc/hosts file to include:

127.0.0.1       flaski.localhost

Citing

Iqbal, A., Duitama, C., Metge, F., Rosskopp, D., Boucas, J. Flaski. (2021). doi:10.5281/zenodo.4849515

Versioning

We recommend that you allways export your session along with your results so that you can in future reproduce them.

Current version can be seen at the end of this page and old sessions version can be checked under https://flaski.age.mpg.de/vcheck/.

If you wish to open an older session under the same package version please use the pyflaski companion package.


Credits

Flaski was build using Font-Awesome toolkit. Please consult the respective project for license information.

The Bioinformatics Core Facility of the Max Planck Institute for Biology of Ageing, Cologne, Germany.