Building Impressory from source

Impressory is an open source project. This means that one way to run the server is to compile and run the source code. These instructions assume you intend to run the server on Linux or Mac. (We’ll develop Windows instructions in due course.)

First, we need a few pieces of software:

  • MongoDB, the database that Impressory uses.
  • A Java Virtual Machine. Impressory is written in Scala, which runs on the JVM.
  • sbt, the Scala Build Tool. (It’s not very big.)
  • git, to get the source code so we can build it.

Then we can build the software

  1. Clone the sourcecode repository from GitHub:

    $ git clone https://github.com/impressory/impressory.git
  2. Ask sbt to build the distribution zip file. This builds a zip file containing everything you need to run the server:

    $ sbt dist

    This builds the distribution zip in target/universal/impressory-0.2-SNAPSHOT.zip You can copy this file wherever you’d like to run the server from.

  3. Unzip the distribution file it made:

    $ unzip impressory-0.2-SNAPSHOT.zip
  4. To run the server, you now just run the start-up script. The instructions below are for Linux (using nohup so that when you close the terminal the program doesn’t also close):

    $ nohup impressory-0.2-SNAPSHOT/bin/impressory > log.out 2> err.out &

The server should now be up and running, listening on port 9000. Open a web browser and visit it. The first user to register is given administrative rights, so you should make sure that’s you!

Although that’s compiled and run the server, there are probably a few things you’ll still want to configure:

  • Database environment variables
  • Social media logins
  • HTTPS
  • Port redirection
Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.