Skip to content
James Lamine edited this page Sep 8, 2017 · 15 revisions

Windows and Mac OSX

PhamDB is distributed as a Docker image which runs on Linux. It was originally designed to run on a server shared between several researchers, but it's easy to set it up on your own laptop or desktop. Windows and OSX are supported through Kitematic, a tool for managing docker containers on Windows and Mac.

How to Install

2. Once the Docker Toolbox is installed, launch Kitematic

3. Wait for Kitematic to finish it's initial setup

4. If prompted to 'Connect to Dockerhub', click "SKIP FOR NOW"

5. Once Kitematic loads, search for 'PhamDB'

6. Click 'CREATE'

7. Wait for Kitematic to download and start PhamDB

8. PhamDB is now running. Click on the box with the arrow next to "WEB PREVIEW" to open the PhamDB web interface in your browser. This is a website on your local network.

9. Congratulations, PhamDB is set up and ready to be used!

The local PhamDB website is only available when Kitematic is running. If you restart your machine, you will need to start PhamDB in order to get back to your work. To do this, open Kitematic and start the PhamDb container. Then click the arrow next to "WEB PREVIEW" to launch the PhamDB web interface.

Next steps

Head over to Using PhamDB to learn about the available features.

Linux

PhamDB is distributed as a Docker image. It is designed to be installed on a server, but can also be used locally.

Command Line Installation

Use the following commands to download and run PhamDB:

Download the image:

docker pull jglamine/phamdb:latest

Create a directory to store the database in:

mkdir /home/<username>/phamdb

Run the server as a daemon, set to start automatically when the server starts.

docker run -d --restart=always -p=80:80 -v /home/<username>/phamdb:/dockerdata jglamine/phamdb:latest

You can now use PhamDB by visiting your server's IP address with a web browser. If you ran the above command locally, this will be http://localhost .

Next steps

Head over to Using PhamDB to learn about the available features.