Skip to content

Latest commit

 

History

History
executable file
·
69 lines (35 loc) · 2.77 KB

README.md

File metadata and controls

executable file
·
69 lines (35 loc) · 2.77 KB

DOI

ecoSound-web

Description

Web application for ecoacoustics to manage, navigate, visualise, annotate, and analyse soundscape recordings.

Credits and license

Designed by Kevin Darras, developed by Noemi Perez and Dilong Liu. ecoSound-web was forked from BioSounds and is licensed under the GNU General Public License, v3.

The corresponding updatable scientific publication is in F1000Research.

Quick start for end users

A working instance of ecoSound-web can be accessed here with limited functionality within the open collections.

You may learn about the basic functionality in the user guide (see Wiki).

Contact us for a collaboration.

Quick start for developers

We use Docker to run the app in your computer. We provide install.sh and run.sh files with all necessary commands, and a Makefile with extra commands to access the docker containers.

You need to install docker and docker-compose standalone directly in your machine. Please read the documentation and follow the instructions carefully. We don't offer support for docker installation and configuration.

Important: this setup is intended for developing and testing purposes ONLY. It is in no way ready for production. Please read the Server Installation section.

Installation

sh install.sh

Run

sh run.sh

Using ecoSound-web

Open http://localhost:8080

Log in with username: admin, password: Administrator20

Important: please change the password of this administrator user or delete it once you have ecoSound-web running on production and have your own admin users.

Stop

docker-compose stop

Optional: clean restart (removing containers)

docker container prune

Server installation

With Docker

If you want to use Docker for your own server installation, please consult with a devOps engineer or someone with the necessary knowledge to manage it properly, depending on your hosting setup.

The current Docker configuration Dockerfile can be used for your preferred setup.

Without Docker

Like any other web app, ecoSound-web can be installed without Docker (see Wiki).

Configuration file

For both cases (with and without Docker), you'll need to set the configuration values in the config.ini file, according to your server setup.