Skip to content

Commit

Permalink
More guide updates [IMMUTANT-538]
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias committed Mar 25, 2015
1 parent b1fd69b commit f31519f
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 23 deletions.
1 change: 0 additions & 1 deletion docs/guides/installation.md
Expand Up @@ -138,7 +138,6 @@ see our [WildFly guide].

[builds]: http://immutant.org/builds/2x/
[latest-api]: https://projectodd.ci.cloudbees.com/job/immutant2-incremental/lastSuccessfulBuild/artifact/target/apidocs/index.html
[The Deuce]: http://immutant.org/news/2014/04/02/the-deuce/
[Compojure]: https://github.com/weavejester/compojure
[Luminus]: http://www.luminusweb.net/
[WildFly]: http://wildfly.org/
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/logging.md
Expand Up @@ -64,7 +64,7 @@ can modify your `:dependencies` like so:
```clojure

:dependencies [...
[org.immutant/immutant "2.x.incremental.284"
[org.immutant/immutant "{{version}}"
:exclusions [ch.qos.logback/logback-classic]]
[org.apache.logging.log4j/log4j-core "2.0.2"]
[org.apache.logging.log4j/log4j-slf4j-impl "2.0.2"]]
Expand All @@ -82,7 +82,7 @@ above, and it is written to the console and to
`$WILDFLY_HOME/standalone/log/server.log`. Any log messages that
Immutant itself generates will be handled by jboss-logging, as will
anything your app logs via [clojure.tools.logging] \(or [Timbre], if
you configure it to delegate to clojure.tools.logging) or writes to
you configure it to delegate to clojure.tools.logging), or writes to
stdout/stderr.

If you need to alter the default logging configuration, you have three options:
Expand Down Expand Up @@ -132,12 +132,12 @@ file, you'll need to add the following to your `project.clj`:
Once you disable the logging subsystem, you can now provide a custom
`logback.xml` as we discussed above, with one important difference -
the `logback.xml` must reside in the war file instead of simply on the
application's classpath. Therefore, you'll also need to put your
application's classpath. Therefore, you'll need to put your
`logback.xml` in `war-resources/WEB-INF/lib/`.

You can also still provide an alternate SLF4J implementation as we did
above, but any configuration for it (`log4j.xml`, etc.), will need to
be in `WEB-INF/lib` as well.
be in `war-resources/WEB-INF/lib` as well.

Now, regenerate your war file, and you should be good to go. For more
information on running your application in WildFly, see our
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/messaging.md
Expand Up @@ -5,8 +5,8 @@
:description "Simple creation and usage of distributed queues and topics"}
---

If you're coming from Immutant 1.x, you may notice that the artifact
has been renamed (`org.immutant/immutant-messaging` is now
If you're coming from Immutant 1.x, you may notice that the messaging
artifact has been renamed (`org.immutant/immutant-messaging` is now
`org.immutant/messaging`), and the API has changed a bit. We'll point
out the notable API changes as we go.

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/scheduling.md
Expand Up @@ -4,11 +4,11 @@
:description "Schedule asynchronous jobs"}
---

If you're coming from Immutant 1.x, you'll notice that the namespace
and artifact have been renamed (what used to be `immutant.jobs` and
`org.immutant/immutant-jobs` is now `immutant.scheduling` and
`org.immutant/scheduling`), and the API has changed a bit. It's still
based on Quartz 2.2, though.
If you're coming from Immutant 1.x, you'll notice that the scheduling
namespace and artifact have been renamed (what used to be
`immutant.jobs` and `org.immutant/immutant-jobs` is now
`immutant.scheduling` and `org.immutant/scheduling`), and the API has
changed a bit. It's still based on Quartz 2.2, though.

## The API

Expand Down
22 changes: 11 additions & 11 deletions docs/guides/wildfly.md
Expand Up @@ -4,7 +4,7 @@
:description "Deploying your app to WildFly"}
---

One of [the primary goals for The Deuce](/news/2014/04/02/the-deuce/)
One of [the primary goals for Immutant 2.x](/news/2014/04/02/the-deuce/)
was the removal of the ancient AS7 fork we lugged around in
Immutant 1.x. This eliminates the need to install and deploy your apps
into a "container" to use the Immutant libraries.
Expand All @@ -27,9 +27,9 @@ container requires some "glue code" that must be aware of the
container's implementation.

For this reason, Immutant intentionally uses the same services as
[WildFly], the community-supported upstream project for the
commercially-supported [JBoss EAP] product. And these are the
containers we'll initially support.
[WildFly], the community-supported upstream project for the next
version of the commercially-supported [JBoss EAP] product. And these
are the containers we'll initially support.

## WildFly

Expand All @@ -39,38 +39,38 @@ write them ourselves. :)

Thankfully, installing WildFly is trivial:

$ wget http://download.jboss.org/wildfly/8.1.0.Final/wildfly-8.1.0.Final.zip
$ unzip wildfly-8.1.0.Final.zip
$ wget http://download.jboss.org/wildfly/8.2.0.Final/wildfly-8.2.0.Final.zip
$ unzip wildfly-8.2.0.Final.zip

Downloading and unpacking it somewhere are all there is to it. Running
it is easy, too:

$ wildfly-8.1.0.Final/bin/standalone.sh
$ wildfly-8.2.0.Final/bin/standalone.sh

Pass it `-h` to see what options it supports. The main one you'll use
is `-c` which refers to one of its config files beneath
`standalone/configuration`. The default config doesn't include
HornetQ, for example, so to use `immutant.messaging`, you'll need to
start WildFly as follows:

$ wildfly-8.1.0.Final/bin/standalone.sh -c standalone-full.xml
$ wildfly-8.2.0.Final/bin/standalone.sh -c standalone-full.xml

And if you want clustering...

$ wildfly-8.1.0.Final/bin/standalone.sh -c standalone-full-ha.xml
$ wildfly-8.2.0.Final/bin/standalone.sh -c standalone-full-ha.xml

You can create your own, of course, too.

## The lein-immutant plugin

The [lein-immutant] plugin was fundamental to developing apps for
Immutant 1.x. In *The Deuce*, it's only required if you wish to deploy
Immutant 1.x. In 2.x, it's only required if you wish to deploy
your Clojure apps to WildFly, and its formerly numerous tasks have
been reduced to two: `immutant war` and `immutant test`. Add the
latest version to the `:plugins` section of your `project.clj` to
install it, e.g.

:plugins [[lein-immutant "2.0.0-beta1"]]
:plugins [[lein-immutant "2.0.0"]]

### Creating a war file

Expand Down

0 comments on commit f31519f

Please sign in to comment.