Supported Operating Systems
- CrushPaper has been developed on Windows 7, Windows 8 and on Linux.
- It is pure Java and so it should work on most operating systems.
How to Build CrushPaper
- Install Java. The version of Java used during development is 1.8.0_40 64 bit.
- Install Maven. The version of Maven used during development is 3.2.5.
- In the root of the crushpaper project run
mvn package. This should compile all classes, run all tests, and create the executable JAR.
- To build without running the tests run
mvn package -Dmaven.test.skip=true.
- To build with Eclipse follow these directions.
How to Install the CrushPaper Server
- Either download or build (see below) the CrushPaper Server executable Jar. It is named crushpaper-<version.jar.
- You can download it from GitHub.
- It is recommended that you run the CrushPaper server as a dedicated OS userid but this is optional.
- It is recommended that you use HTTPS but this is optional. You can generate an SSL certificate for free by following these directions.
- Choose the directory where you want to run CrushPaper. Call it
- If using Unix:
mkdir -p $CRUSHPAPER/logs $CRUSHPAPER/tmp $CRUSHPAPER/db $CRUSHPAPER/config $CRUSHPAPER/bin $CRUSHPAPER/backups $CRUSHPAPER/sessions
- If using Windows:
mkdir %CRUSHPAPER%\logs %CRUSHPAPER%\tmp %CRUSHPAPER%\db %CRUSHPAPER%\config %CRUSHPAPER%\bin %CRUSHPAPER%/backups %CRUSHPAPER%/sessions
- Copy the CrushPaper Server executable JAR (
crushpaper-version.jar) into the
bin directory that was just created.
crushpaper.properties in the
config directory that was just created with:
http.port = 8080
database.directory = db
temporary.directory = tmp
logs.directory = logs
sessionStore.directory = sessions
singleUser = yourid
- If using Unix then create
nohup java -server \
-jar ./bin/crushpaper-version.jar \
-properties ./config/crushpaper.properties \
>> ./logs/crushpaper.log 2>&1 &
Don't forget to make the script executable with:
chmod +x $CRUSHPAPER/bin/start
- If using Windows then create
-jar .\bin\crushpaper-<version>.jar ^
-properties .\config\crushpaper.properties ^
1> .\logs\crushpaper.log 2>&1
- If using Unix then start the CrushPaper server by running
- If using Windows then start the CrushPaper server by running
- Open your browser and visit http://localhost:8080.
How to Run the CrushPaper Server
- Ensure that your JAVA_HOME environment variable is set and your PATH environment variable includes the Java bin directory.
- The CrushPaper server can be run from any working directory but remember that relative paths in command line arguments and property files are relative to this working directory.
- Run it with this command:
$ nohup java -jar <path/to/crushpaper-version.jar> -properties <path/to/crushpaper.properties> 2>&1 > path/to/logfile &
- To run it from the build area use this command:
$ java -jar target/crushpaper-*.jar -properties src/main/sampleconfig/example.properties
How to Kill the CrushPaper Server
- If you
kill -9 the server you risk corrupting the H2 database, although the H2 will usually be able recover the database at start up.
- You can shutdown the server with
- With administrator privileges you may also shutdown the server from its web site.
Command Line Arguments
- -properties <path/to/crushpaper.properties> - This is the path to the CrushPaper server properties file. This argument is mandatory.
- -help - This argument results in a very simple help message being printed.
Configuration File Properties
- database.directory = <path/to/database/directory> - This is the path to the directory where the H2 database is stored.
- temporary.directory = <path/to/temporary/directory> - This is the path to the directory where temporary files are stored. These temporary files are user backup files that are in the process of being restored.
- logs.directory = <path/to/logs/directory> - This is the path to the directory where the server's HTTP request logs are stored.
- http.port = <port> - This is the HTTP port that the server listens on. Either this property or
https.port must be set. Both can be set.
- singleUser = <username> - If this set to any value then anyone who can access the server is treated as if they signed into the account named <username>. This may be reasonable to use if CrushPaper is installed on a PC or laptop which is accessible only to trusted networks. Defaults to blank which disables this functionality.
- loopbackIsAdmin = <true|false> - This treats any session as an admin user if the session is connected from the same host on which the CrushPaper server is running using the loopback interface, i.e
- sessionStore.directory = <path/to/directory> - This is the directory used to store HTTP session information. If this is not set then HTTP sessions will not be persist across server restarts.
- https.port = <port> - This is the HTTPS port that the server listens on. Either this property or
http.port must be set. Both can be set.
- https.keystore = <path/to/file> - This is the keystore file used for HTTPS. It must be set if
https.port is set.
- https.keystorePassword = <password> - This is the password for the keystore file. It is optional because not all keystores have passwords.
- https.keymanagerPassword = <password> - This is the keymanager password for the keystore file. Not all keystores require this.
- allowSaveIfNotSignedIn = <true|false> - If this is true creating a notebook automatically creates a new account for the session if the user is not signed in. Only set this to true for servers where you want to encourage people to try it out. Defaults to false.
- allowSelfSignUp = <true|false> - If this is true anyone who can access the server can create an account. Defaults to false.
- https.proxiedPort = <port> - Only set this if connections are forwarded from another port to
https.port. This may only be set if
https.port is set.
H2 Database Documentation
- The H2 Database documentation is here.
Try CrushPaper for free without creating an account!
Or watch the Demo Movie