Skip to content

Installing and Running Overview

Jump to bottom
Jonathan Stray edited this page Apr 24, 2014 · 31 revisions

Follow these instructions to get your very own Overview server up and running. It's a bit more work than just using overviewproject.org, but provides much higher security as your documents will never leave your own computer.

Installing on Windows 8

2014-4-24 Windows instructions are not well tested! If you do try this, please let us know how it works.

  1. You need a 64 bit version of Windows to run the Overview server. If you are unsure which version of Windows you have, check here.

  2. First you will need the Postgres database software. The easiest way is to download and install from http://www.postgresql.org/download/windows/

  3. Next you will need Java 7 installed (if it is not installed already. Go to Control Panel and see if Java is listed under Programs.) Get Java 7 here: http://www.java.com/en/download/index.jsp

  4. Then download the latest Overview release which will have a filename like overview-server-YYYYMMDDRR.zip from https://github.com/overview/overview-server/releases.

  5. Extract all the files from this zip file into a folder.

  6. Inside the extracted folder, navigate to runner\target\universal\stage\bin and double-click on runner.bat

  7. Open your web browser and go to localhost:9000. You should see a login screen! Login with the default username and password of [email protected] and you are done!

Installing on Mac OS X

  1. First you will need the Postgres database software. The easiest way is to download and install from http://postgresapp.com

  2. Next you will need Java 7 installed (if it is not installed already. Go to System Preferences and look for the Java icon to see if Java is installed, and if so, what version.) Get Java 7 here: http://www.java.com/en/download/index.jsp

  3. Then download the latest Overview release which will have a filename like overview-server-YYYYMMDDRR.zip from https://github.com/overview/overview-server/releases.

  4. Unzip it, and open a Terminal window in the directory where all of the files are unzipped. You will need to cd into this directory.

  5. Type ./run. The server is ready when you see the following message:

    [overview-server] [info] play - Application started (Prod) [overview-server] [info] play - Listening for HTTP on /0:0:0:0:0:0:0:0:9000

  6. Open your web browser and go to localhost:9000. You should see a login screen! Login with the default username and password of [email protected] and you are done!

Installing on Ubuntu Linux

Warning We support Overview on Ubuntu Linux 14.04 LTS and above. (Really, we support any distribution that includes Postgresql 9.3 or above.) Older versions of Postgresql might not work perfectly.

First, download the latest release of overview-server-YYYYMMDDRR.zip from https://github.com/overview/overview-server/releases. Done? Now you have two ways to install it.

On the command-line

Just run this:

sudo apt-get install openjdk-7-jre-headless postgresql
unzip /path/to/overview-server-YYYYMMDDRR.zip
cd overview-server-YYYYMMDDRR
./run

Leave that running, browse to http://localhost:9000 and log in as [email protected] with password [email protected].

To quit, press Ctrl+C where ./run is running. Don't worry: your data is safe no matter when you quit.

Without the command-line

  1. Using Ubuntu Software Center, install openjdk-7-jre-headless and postgresql.
  2. Move overview-server-YYYYMMDDRR.zip somewhere where you know you can find it again.
  3. Right-click on overview-server-YYYYMMDDRR.zip and click Extract here.
  4. Double-click on the new overview-server-YYYYMMDDRR folder.
  5. Wait for the colorful text to stop scrolling in the terminal that pops up.
  6. Browse to http://localhost:9000 and log in as [email protected] with password [email protected].

To quit, close the terminal. Don't worry: your data is safe no matter when you quit.

Upgrading (on all operating systems)

Want to download a new version? Download it from https://github.com/overview/overview-server/releases and then:

  1. Quit the old version of Overview.
  2. Extract the new version (probably near where you extracted the old version).
  3. Copy the database folder from the first overview-YYYYMMDDRR folder into the second overview-YYYYMMDDRR folder.
  4. Copy the data subfolder of the search-index folder from the first overview-YYYYMMDDRR folder into the second overview-YYYYMMDDRR folder's search-index subfolder. (Got that? You're copying overview-server-1111111111/search-index/data so it becomes overview-server-2222222222/search-index/data.)
  5. Run the new version of Overview.
Clone this wiki locally