Skip to content

Installing and Running Overview

Jump to bottom
thejonas edited this page Mar 10, 2015 · 31 revisions

NOTE: THE BELOW INSTRUCTIONS ARE OBSOLETE.

Instead, follow the directions for Setting up a development Environment.

Follow these instructions to get your very own Overview server up and running.

It's a more work (and it's probably slower) than using https://www.overviewproject.org, but it ensures your documents will never leave your own computer.

Installing on Windows 8

  1. Install the Postgres database from http://www.enterprisedb.com/products-services-training/pgdownload#windows. (This is what PostgreSQL officially recommends.)
    1. First, click the relevant download: either "Win x86-32" or "Win x86-64". (If you know you're using 64-bit Windows, choose the "64". If you're unsure, choose "32".)
    2. When prompted to save or run, choose "Run". Choose "Yes" when prompted to make changes to your computer.
    3. Click "Next", "Next", "Next". (Don't change the installation directory, or Overview won't work.)
    4. When asked for a password, enter postgres twice. (You can enter anything, really; Overview ignores this completely, and you won't ever need to type it in again.)
    5. Click "Next", "Next", "Next"
    6. Uncheck the "Stack Builder" checkbox, then click "Finish"
    7. (If you care, open your "Control Panel", go to "Administrative Tasks", "Services", "Postgresql" and change "Startup Type" to "Manual". Overview needs PostgreSQL to be installed, but it doesn't need it to be running so you can disable it.)
  2. Install Java 8. (It might be installed already; you can check in "Programs" in the Control Panel.)
    1. Browse to https://www.java.com and click "Free Java Download".
    2. Click "Agree and Start Free Download". When prompted, choose "Run" and "Yes".
    3. Click "Install"
    4. Uncheck "Install the Ask Toolbar" and click "Next".
    5. Click "Close". A web browser window will pop up; you may close it.
  3. Download the latest release of overview-server-YYYYMMDDRR.zip from https://github.com/overview/overview-server/releases/latest.
  4. Extract all the files from this zip file into a folder.
  5. Inside the extracted folder, double-click on Overview for Windows.
  6. Browse to http://localhost:9000 and log in as [email protected] with password [email protected].

Installing on Mac OS X

  1. Install PostgreSQL:
    1. Download the latest version of Postgres.app from http://postgresapp.com/
    2. Install it
    3. Run it once, then exit
  2. Install Java 8 from https://www.java.com/en/download/index.jsp
  3. Download the latest release of overview-server-YYYYMMDDRR.zip from https://github.com/overview/overview-server/releases/latest.
  4. Extract it somewhere, and open the extracted directory in Finder.
  5. Ctrl-Click or Right-click on Overview for Mac OS X.command and select Open. When the dialog box asks if you are sure you want to open the application, click on the Open button. From then on, you can start Overview by double-clicking on Overview for Mac OS X.command.
  6. If you're prompted to install XCode, click "Install". When installation finishes, re-do step 5.
  7. Browse to http://localhost:9000 and log in as [email protected] with password [email protected].

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/latest. Done? Now you have two ways to install it.

On the command-line

Just run this:

sudo apt-get install openjdk-8-jre-headless postgresql build-essential
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-8-jre-headless, postgresql and build-essential.
  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. Enter the new overview-server-YYYYMMDDRR folder.
  5. Double-click on Overview for Linux.
  6. Wait for the colorful text to stop scrolling in the terminal that pops up.
  7. 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. Run the new version of Overview.
Clone this wiki locally