Skip to content

Commit

Permalink
Finatra - added and updated documentation.
Browse files Browse the repository at this point in the history
RB_ID=691632
TBR=true
  • Loading branch information
cacoco authored and jenkins committed Jun 11, 2015
1 parent 11f3565 commit 93ce624
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
9 changes: 4 additions & 5 deletions http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -736,12 +736,11 @@ File Server
===============================
Finatra's file server support is meant for internal apps only. Do not use the fileserver for production apps requiring a robust high performance file serving solution.

All files are served out of src/main/webapp.
By default, files are served from the classpath. You can use the flag `-doc.root` to customize the classpath root.

To run the server locally with hotloaded files resolved from disk (instead of from classpath), set the following Java System Property
```scala
env=dev
```
To serve files from the local file system, use the flag `-local.doc.root`. Note that setting Java System Property `-Denv=env` is no longer required nor supported. Setting the `-local.doc.root` flag will trigger the same `localFileMode` behavior.

Also note that it is **an error** to attempt to set both the `-doc.root` and the `-local.doc.root` flags. Either do nothing to load resources from the base of the classpath, configure a classpath "namespace" by setting the `-doc.root` **or** load files from a local filesystem location specified by the `-local.doc.root` flag.

## File Serving Examples

Expand Down
1 change: 0 additions & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.3.2")
addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.13.0")
addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.1.8")
addSbtPlugin("com.twitter" %% "scrooge-sbt-plugin" % "3.15.0")
addSbtPlugin("com.typesafe.sbt" % "sbt-pgp" % "0.8.3")
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.0.4")
addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.0.0")

0 comments on commit 93ce624

Please sign in to comment.