diff options
| author | Chris Rebert <github@rebertia.com> | 2014-12-09 23:29:30 +0300 |
|---|---|---|
| committer | Chris Rebert <github@rebertia.com> | 2014-12-09 23:29:30 +0300 |
| commit | af05256f30dcc332b3a9d28681839816a2c5f156 (patch) | |
| tree | 9f95ec2a58736cc6499539cf59dd36c275a707d6 | |
| parent | b55b2205a0247c0c4d1dcf42d3c25d79d4468a07 (diff) | |
README.md: mention SETUP.md
| -rw-r--r-- | README.md | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -48,6 +48,8 @@ Using Savage involves two GitHub repos (which can both be the same repo, althoug Java 7+, [Git](http://git-scm.com/), OpenSSH, and a Unix-like OS are required to run Savage. For instructions on building Savage yourself, see [the Contributing docs](https://github.com/twbs/savage/blob/master/CONTRIBUTING.md). +For step-by-step setup instructions, see [`SETUP.md`](https://github.com/twbs/savage/blob/master/SETUP.md). + Savage accepts exactly one optional command-line argument, which is the port number to run its HTTP server on, e.g. `8080`. If you don't provide this argument, the default port specified in `application.conf` will be used. Once you've built the JAR, run e.g. `java -jar savage-assembly-1.0.jar 8080` (replace `8080` with whatever port number you want). Note that running on ports <= 1024 requires root privileges (not recommended) or using port mapping. When running Savage, its working directory needs to be a non-bare git repo which is a clone of the repo being monitored. |