diff --git a/akka-docs/src/main/paradox/java/scala-compat.md b/akka-docs/src/main/paradox/java/scala-compat.md index bbc1901b11..71a5fe9df7 100644 --- a/akka-docs/src/main/paradox/java/scala-compat.md +++ b/akka-docs/src/main/paradox/java/scala-compat.md @@ -1,5 +1,8 @@ # Java 8 and Scala Compatibility +Akka requires that you have [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or +later installed on your machine. + ## Scala and Java APIs Akka has both a @ref:[Scala Documentation](../scala.md) and a @ref:[Java Documentation](../java.md). @@ -26,4 +29,13 @@ We will only be able to seamlessly integrate all functional interfaces once we can rely on Scala 2.12 to provide full interoperability—this will mean that Scala users can directly implement Java Functional Interfaces using lambda syntax as well as that Java users can directly implement Scala functions using lambda -syntax. \ No newline at end of file +syntax. + +## Do not use -optimize Scala compiler flag + +@@@ warning + +Akka has not been compiled or tested with -optimize Scala compiler flag. +Strange behavior has been reported by users that have tried it. + +@@@ diff --git a/akka-docs/src/main/paradox/scala/additional/deploy.md b/akka-docs/src/main/paradox/scala/additional/deploy.md new file mode 100644 index 0000000000..dff0c3a797 --- /dev/null +++ b/akka-docs/src/main/paradox/scala/additional/deploy.md @@ -0,0 +1,39 @@ +# How can I deploy Akka? + +Akka can be used in different ways: + + * As a library: used as a regular JAR on the classpath and/or in a web app, to +be put into `WEB-INF/lib` + * As an application packaged with [sbt-native-packager](https://github.com/sbt/sbt-native-packager) + * As an application packaged and deployed using [Lightbend ConductR](http://www.lightbend.com/products/conductr). + +## Native Packager + +[sbt-native-packager](https://github.com/sbt/sbt-native-packager) is a tool for creating +distributions of any type of application, including Akka applications. + +Define sbt version in `project/build.properties` file: + +```none +sbt.version=0.13.13 +``` + +Add [sbt-native-packager](https://github.com/sbt/sbt-native-packager) in `project/plugins.sbt` file: + +```none +addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.1.5") +``` + +Follow the instructions for the `JavaAppPackaging` in the [sbt-native-packager plugin documentation](http://sbt-native-packager.readthedocs.io/en/latest/archetypes/java_app/index.html). + +## In a Docker container + +You can use both Akka remoting and Akka Cluster inside of Docker containers. But note +that you will need to take special care with the network configuration when using Docker, +described here: @ref:[Akka behind NAT or in a Docker container](../../scala/remoting.md#remote-configuration-nat) + +For an example of how to set up a project using Akka Cluster and Docker take a look at the +["akka-docker-cluster" sample](https://github.com/muuki88/activator-akka-docker). + + + diff --git a/akka-docs/src/main/paradox/scala/additional/index.md b/akka-docs/src/main/paradox/scala/additional/index.md index 833960e1fe..dbb3856840 100644 --- a/akka-docs/src/main/paradox/scala/additional/index.md +++ b/akka-docs/src/main/paradox/scala/additional/index.md @@ -6,9 +6,9 @@ * [../common/binary-compatibility-rules](../common/binary-compatibility-rules.md) * [../common/may-change](../common/may-change.md) +* [deploy](deploy.md) * [faq](faq.md) * [books](books.md) * [osgi](osgi.md) -* [TODO](leftovers.md) @@@ diff --git a/akka-docs/src/main/paradox/scala/additional/leftovers.md b/akka-docs/src/main/paradox/scala/additional/leftovers.md deleted file mode 100644 index d5bb62635c..0000000000 --- a/akka-docs/src/main/paradox/scala/additional/leftovers.md +++ /dev/null @@ -1,241 +0,0 @@ -# TODO - -These topics should be incorporated somewhere? - -## Prerequisites - -Akka requires that you have [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or -later installed on your machine. - -## Akka can be used in different ways - -Akka is a toolkit, not a framework: you integrate it into your build like any other library -without having to follow a particular source code layout. When expressing your systems as collaborating -Actors you may feel pushed more towards proper encapsulation of internal state, you may find that -there is a natural separation between business logic and inter-component communication. - -Akka applications are typically deployed as follows: - - * as a library: used as a regular JAR on the classpath or in a web app. - * packaged with [sbt-native-packager](https://github.com/sbt/sbt-native-packager). - * packaged and deployed using [Lightbend ConductR](http://www.lightbend.com/products/conductr). - -## How can I use and deploy Akka? - -Akka can be used in different ways: - - * As a library: used as a regular JAR on the classpath and/or in a web app, to -be put into `WEB-INF/lib` - * As an application packaged with [sbt-native-packager](https://github.com/sbt/sbt-native-packager) - * As an application packaged and deployed using [Lightbend ConductR](http://www.lightbend.com/products/conductr). - -### Native Packager - -[sbt-native-packager](https://github.com/sbt/sbt-native-packager) is a tool for creating -distributions of any type of application, including Akka applications. - -Define sbt version in `project/build.properties` file: - -```none -sbt.version=0.13.13 -``` - -Add [sbt-native-packager](https://github.com/sbt/sbt-native-packager) in `project/plugins.sbt` file: - -```none -addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.1.5") -``` - -Follow the instructions for the `JavaAppPackaging` in the [sbt-native-packager plugin documentation](http://sbt-native-packager.readthedocs.io/en/latest/archetypes/java_app/index.html). - -### In a Docker container - -You can use both Akka remoting and Akka Cluster inside of Docker containers. But note -that you will need to take special care with the network configuration when using Docker, -described here: @ref:[Akka behind NAT or in a Docker container](../../scala/remoting.md#remote-configuration-nat) - -For an example of how to set up a project using Akka Cluster and Docker take a look at the -["akka-docker-cluster" sample](https://github.com/muuki88/activator-akka-docker). - -## Commercial Support - -Akka is available from Lightbend Inc. under a commercial license which includes -development or production support, read more [here](http://www.lightbend.com/how/subscription). - -## Using a snapshot version - -The Akka nightly snapshots are published to [http://repo.akka.io/snapshots](http://repo.akka.io/snapshots)/ and are -versioned with both `SNAPSHOT` and timestamps. You can choose a timestamped -version to work with and can decide when to update to a newer version. - -@@@ warning - -The use of Akka SNAPSHOTs, nightlies and milestone releases is discouraged unless you know what you are doing. - -@@@ - - -## Using a build tool - -Akka can be used with build tools that support Maven repositories. - -## Using Akka with Maven - -The simplest way to get started with Akka and Maven is to download the ready to run sample -named [Akka Main in Java](@exampleCodeService@/akka-samples-main-java). - -Since Akka is published to Maven Central (for versions since 2.1-M2), it is -enough to add the Akka dependencies to the POM. For example, here is the -dependency for akka-actor: - -```xml - - com.typesafe.akka - akka-actor_@binVersion@ - @version@ - -``` - -For snapshot versions, the snapshot repository needs to be added as well: - -```xml - - - akka-snapshots - - true - - http://repo.akka.io/snapshots/ - - -``` - -**Note**: for snapshot versions both `SNAPSHOT` and timestamped versions are published. - -## Using Akka with SBT - -The simplest way to get started with Akka and SBT is to use a [Gitter8](http://www.foundweekends.org/giter8/) template -named [Hello Akka!](https://github.com/akka/hello-akka.g8). If you have *sbt* already installed, you can create a project -from this template by running: - -``` -sbt new akka/hello-akka.g8 -``` - -Summary of the essential parts for using Akka with SBT: - -SBT installation instructions on [http://www.scala-sbt.org/release/tutorial/Setup.html](http://www.scala-sbt.org/release/tutorial/Setup.html) - -`build.sbt` file: - -``` -name := "My Project" - -version := "1.0" - -scalaVersion := "@scalaVersion@" - -libraryDependencies += - "com.typesafe.akka" %% "akka-actor" % "@version@" @crossString@``` - -**Note**: the libraryDependencies setting above is specific to SBT v0.12.x and higher. If you are using an older version of SBT, the libraryDependencies should look like this: - -``` -libraryDependencies += - "com.typesafe.akka" % " -@ref:[akka-actor](../general/configuration.md#akka-actor) -@binVersion -@" % "@version@"``` - -For snapshot versions, the snapshot repository needs to be added as well: - -``` -resolvers += "Akka Snapshot Repository" at " -[http://repo.akka.io/snapshots](http://repo.akka.io/snapshots) -/"``` - -## Using Akka with Gradle - -Requires at least [Gradle](https://gradle.org) 1.4 -Uses the [Scala plugin](http://www.gradle.org/docs/current/userguide/scala_plugin.html) - -``` -apply plugin: 'scala' - -repositories { - mavenCentral() -} - -dependencies { - compile 'org.scala-lang:scala-library:@ -[scalaVersion@](mailto:scalaVersion@) -' -} - -tasks.withType(ScalaCompile) { - scalaCompileOptions.useAnt = false -} - -dependencies { - compile group: 'com.typesafe.akka', name: ' -@ref:[akka-actor](../general/configuration.md#akka-actor) -@ -[binVersion@](mailto:binVersion@) -', version: ' -[@version](mailto:@version) -@ -' - compile group: 'org.scala-lang', name: 'scala-library', version: ' -[@scalaVersion](mailto:@scalaVersion) -@ -' -}``` - -For snapshot versions, the snapshot repository needs to be added as well: - -``` -repositories { - mavenCentral() - maven { - url " -[http://repo.akka.io/snapshots](http://repo.akka.io/snapshots) -/" - } -}``` - -## Using Akka with Eclipse - -Setup SBT project and then use [sbteclipse](https://github.com/typesafehub/sbteclipse) to generate an Eclipse project. - -## Using Akka with IntelliJ IDEA - -Setup SBT project and then use [sbt-idea](https://github.com/mpeltonen/sbt-idea) to generate an IntelliJ IDEA project. - -## Using Akka with NetBeans - -Setup SBT project and then use [nbsbt](https://github.com/dcaoyuan/nbsbt) to generate a NetBeans project. - -You should also use [nbscala](https://github.com/dcaoyuan/nbscala) for general scala support in the IDE. - -## Do not use -optimize Scala compiler flag - -@@@ warning - -Akka has not been compiled or tested with -optimize Scala compiler flag. -Strange behavior has been reported by users that have tried it. - -@@@ - -## Build from sources - -Akka uses Git and is hosted at [Github](https://github.com). - -Continue reading the [CONTRIBUTING](https://github.com/akka/akka/blob/master/CONTRIBUTING.md) - -## Need help? - -If you have questions you can get help on the [Akka Mailing List](https://groups.google.com/group/akka-user). - -You can also ask for [commercial support](https://www.lightbend.com). - -Thanks for being a part of the Akka community. \ No newline at end of file diff --git a/akka-docs/src/main/paradox/scala/project/index.md b/akka-docs/src/main/paradox/scala/project/index.md index a522d9b047..fe38661825 100644 --- a/akka-docs/src/main/paradox/scala/project/index.md +++ b/akka-docs/src/main/paradox/scala/project/index.md @@ -7,7 +7,6 @@ * [migration-guides](migration-guides.md) * [issue-tracking](issue-tracking.md) * [licenses](licenses.md) -* [sponsors](sponsors.md) * [links](links.md) @@@ \ No newline at end of file diff --git a/akka-docs/src/main/paradox/scala/project/links.md b/akka-docs/src/main/paradox/scala/project/links.md index 285a151c2f..2857940b89 100644 --- a/akka-docs/src/main/paradox/scala/project/links.md +++ b/akka-docs/src/main/paradox/scala/project/links.md @@ -5,28 +5,31 @@ Commercial support is provided by [Lightbend](http://www.lightbend.com). Akka is part of the [Lightbend Reactive Platform](http://www.lightbend.com/platform). +## Sponsors + +**Lightbend** is the company behind the Akka Project, Scala Programming Language, +Play Web Framework, Lagom, sbt and many other open source projects. +It also provides the Lightbend Reactive Platform, which is powered by an open source core and commercial Enterprise Suite for building scalable Reactive systems on the JVM. Learn more at [lightbend.com](http://www.lightbend.com). + ## Mailing List [Akka User Google Group](http://groups.google.com/group/akka-user) -[Akka Developer Google Group](http://groups.google.com/group/akka-dev) +## Gitter -## Downloads +Chat room about *using* Akka: [![gitter: akka/akka](https://img.shields.io/badge/gitter%3A-akka%2Fakka-blue.svg?style=flat-square)](https://gitter.im/akka/akka) + +A chat room is available for all questions related to developing and contributing to Akka: [![gitter: akka/dev](https://img.shields.io/badge/gitter%3A-akka%2Fdev-blue.svg?style=flat-square)](https://gitter.im/akka/dev) -[http://akka.io/downloads](http://akka.io/downloads) ## Source Code -Akka uses Git and is hosted at [Github](http://github.com). - - * Akka: clone the Akka repository from [http://github.com/akka/akka](http://github.com/akka/akka) +Akka uses Git and is hosted at [Github akka/akka](http://github.com/akka/akka). ## Releases Repository All Akka releases are published via Sonatype to Maven Central, see [search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.typesafe.akka%22) -or -[search.maven.org (Akka versions before 2.4.3)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.typesafe.akka%22) ## Snapshots Repository @@ -34,22 +37,28 @@ Nightly builds are available in [http://repo.akka.io/snapshots](http://repo.akka timestamped versions. For timestamped versions, pick a timestamp from -[http://repo.akka.io/snapshots/com/lightbend/akka/akka-actor_@binVersion@](http://repo.akka.io/snapshots/com/lightbend/akka/akka-actor_@binVersion@)/. +[http://repo.akka.io/snapshots/com/typesafe/akka/akka-actor_@binVersion@](http://repo.akka.io/snapshots/com/typesafe/akka/akka-actor_@binVersion@)/. All Akka modules that belong to the same build have the same timestamp. +@@@ warning + +The use of Akka SNAPSHOTs, nightlies and milestone releases is discouraged unless you know what you are doing. + +@@@ + ### sbt definition of snapshot repository Make sure that you add the repository to the sbt resolvers: ``` -resolvers += "Lightbend Snapshots" at "http://repo.akka.io/snapshots/" +resolvers += "Akka Snapshots" at "http://repo.akka.io/snapshots/" ``` Define the library dependencies with the timestamp as version. For example: ``` libraryDependencies += "com.typesafe.akka" % "akka-remote_@binVersion@" % - "2.1-20121016-001042" + "2.5-20170510-230859" ``` ### maven definition of snapshot repository @@ -74,7 +83,7 @@ Define the library dependencies with the timestamp as version. For example: com.typesafe.akka akka-remote_@binVersion@ - 2.1-20121016-001042 + 2.5-20170510-230859 ``` \ No newline at end of file diff --git a/akka-docs/src/main/paradox/scala/project/sponsors.md b/akka-docs/src/main/paradox/scala/project/sponsors.md deleted file mode 100644 index c3480c13d7..0000000000 --- a/akka-docs/src/main/paradox/scala/project/sponsors.md +++ /dev/null @@ -1,9 +0,0 @@ -# Sponsors - -## Lightbend - -Lightbend is the company behind the Akka Project, Scala Programming Language, -Play Web Framework, Scala IDE, sbt and many other open source -projects. It also provides the Lightbend Stack, a full-featured development -stack consisting of Akka, Play and Scala. Learn more at -[lightbend.com](http://www.lightbend.com). \ No newline at end of file