You can install magpie on a server for online use or locally on your machine.
The latest version of magpie-base (v3.x) requires magpie-backend v2.x to run on the server to function properly. Previous iterations of magpie, require magpie-backend v1.x but will usually also run with magpie-backend v2.x.
Installation on Heroku
Installation using docker
If you are already familiar with docker and docker-compose, the magpie backend is also available as a ready-to-install docker container. You can find more details about this on the GitHub repository: https://github.com/magpie-ea/magpie-docker/
The first-time installation requires an internet connection. After it is finished, the server can be launched offline.
(Note that for local deployment, the default username is
default and the default password is
password. You can change them in
First time installation
- Install Docker from https://docs.docker.com/install/. You may have to launch the application once in order to let it install its command line tools. Ensure that it's running by typing
docker versionin a terminal (e.g., the Terminal app on MacOS or cmd.exe on Windows).
- Although the Docker app on Windows and Mac asks for login credentials to Docker Hub, they are not needed for local deployment . You can proceed without creating any Docker account/logging in.
Linux users would need to install
docker-composeseparately. See relevant instructions at https://docs.docker.com/compose/install/.
Ensure you have Git installed. Clone the server repo with
git clone https://github.com/magpie-ea/magpie-backend.gitor
git clone firstname.lastname@example.org:magpie-ea/magpie-backend.git.
Open a terminal (e.g., the Terminal app on MacOS or cmd.exe on Windows),
cdinto the project directory just cloned via git.
docker-compose upto launch the application every time you want to run the server. Wait until the line
web_1 | [info] Running MAGPIE.Endpoint with Cowboy using http://0.0.0.0:4000appears in the terminal.
localhost:4000in your browser. You should see the server up and running.
Note: Windows 7 users who installed Docker Machine might need to find out the IP address used by
docker-machine instead of
localhost. See Docker documentation for details.