MMseqs2 App and Server
The application runs either:
- on your workstation as a cross-platform desktop application with the help of the electron framework
- on your server through docker-compose, where it can make your sequence or profile databases easily accessible over the web
Head over to the release page and download the latest version. We currently support Linux, macOS and Windows.
Adding a search database
Once the app is installed, open the Settings panel. There you can add either sequence databases in FASTA format, such as our Uniclust databases or profile databases in Stockholm format, such as the PFAM.
Web app quickstart with docker-compose
Make sure you have
docker-compose (>=1.20.0) and
git installed on your server.
To start the MMseqs2 web server execute the following commands. Afterwards you can navigate to http://localhost:8877 on a webserver to access the interface.
# clone the repository git clone https://github.com/soedinglab/MMseqs2-App.git # navigate to our docker recipes cd MMseqs2-App/docker-compose # download the uniclust sequence database ./examples/uniclust/setup.sh # start the server with docker-compose docker-compose up
By default, the server will start on port 8877. You can edit the
.env file in the
docker-compose directory to change this port.
Head over to the Docker recipe readme for more details on running your own server, including how to add your own sequence or profile databases. Take a look at the API documentation to learn how to talk to the server backend.
Building the desktop app
You need to have
make installed on your system.
Afterwards run the following commands, and the apps will appear in the
# clone the repository git clone https://github.com/soedinglab/MMseqs2-App.git cd MMseqs2-App # install all dependencies npm install # build the app for all platforms npm run electron:build