summaryrefslogtreecommitdiffstats
path: root/test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md')
-rw-r--r--test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md92
1 files changed, 92 insertions, 0 deletions
diff --git a/test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md b/test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md
new file mode 100644
index 0000000000..402d9cc145
--- /dev/null
+++ b/test/servlet-containers/karaf/karaf-run/apache-karaf-4.2.1-minimal/README.md
@@ -0,0 +1,92 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Karaf
+
+[Apache Karaf](http://karaf.apache.org) is a modern and polymorphic applications container.
+It's a lightweight, powered, and enterprise ready container powered by OSGi.
+[Apache Karaf](http://karaf.apache.org) is a "product project", providing a complete and turnkey runtime. The runtime is
+"multi-facets", meaning that you can deploy different kind of applications: OSGi or non OSGi, webapplication, services based, ...
+
+## Overview
+
+* **Hot deployment**: Karaf supports hot deployment of OSGi bundles by monitoring
+ jar files inside the [home]/deploy directory. Each time a jar is copied in this folder,
+ it will be installed inside the runtime. You can then update or delete it and changes will
+ be handled automatically. In addition, the Kernel also supports exploded bundles and custom
+ deployers (a spring one is included by default).
+* **Dynamic configuration**: Services are usually configured through the ConfigurationAdmin OSGi
+ service. Such configuration can be defined in Karaf using property files inside
+ the [home]/etc directory. These configurations are monitored and changes on the properties
+ files will be propagated to the services.
+* **Resolver**: Apache Karaf resolver is able to deal with requirements and capabilities of your module,
+ simplifying the way of deploying your applications.
+* **Logging System**: using a centralized logging back end supported by Log4J, Karaf
+ supports a number of different APIs (JDK 1.4, JCL, SLF4J, Avalon, Tomcat, OSGi)
+* **Provisioning**: Provisioning of libraries or applications can be done through a number of
+ different ways, by which they will be downloaded locally, installed and started. It interacts
+ with the resolver to automatically install the required components.
+* **Native OS integration**: Karaf can be integrated into your own Operating System as
+ a service so that the lifecycle will be bound to your Operating System.
+* **Extensible Shell console**: Karaf features a nice text console where you can manage the
+ services, install new applications or libraries and manage their state. This shell is easily
+ extensible by deploying new commands dynamically along with new features or applications.
+* **Remote access**: use any SSH client to connect to the kernel and issue commands in the console
+* **Security & ACL** framework based on JAAS providing complete RBAC solution.
+* **Managing instances**: Karaf provides simple commands for managing instances of Karaf.
+ You can easily create, delete, start and stop instances of Karaf through the console.
+* **Enterprise features**: Karaf provides a bunch of enterprise features that you can use in your applications (JDBC, JPA, JTA, JMS, ...).
+* **WebContainer**: Karaf provides a full features web container, allowing you to deploy your web applications.
+* **REST & Services**: Karaf supports different service frameworks as Apache CXF allowing you to easily implements your services.
+* **Karaf Extensions**: Karaf project is a complete ecosystem. The container can be extended by other Karaf subprojects such as Karaf Decanter, Karaf Cellar, Karaf Cave, ...
+* **Third Party Extensions**: Karaf is a supported runtime for a lot of other projects as [Apache Camel](http://camel.apache.org), and much more.
+
+## Getting Started
+
+For an Apache Karaf source distribution, please read [BUILDING.md](https://github.com/apache/karaf/BUILDING.md) for instructions on building Apache Karaf.
+
+For an Apache Karaf binary distribution, please read [RELEASE-NOTES.md](https://github.com/apache/karaf/RELEASE-NOTES.md) for installation instructions and list of supported
+and unsupported features.
+
+The PDF manual is the right place to find any information about Karaf.
+
+The [examples](http://github.com/apache/karaf/examples) provide a bunch of turnkey minimal applications that you can deploy in Apache Karaf and extend/template as you want.
+
+## Contact Us
+
+To get involved in Apache Karaf:
+
+* [Subscribe](mailto:user-subscribe@karaf.apache.org) or [mail](mailto:user@karaf.apache.org) the [user@karaf.apache.org](http://mail-archives.apache.org/mod_mbox/karaf-user/) list.
+* [Subscribe](mailto:dev-subscribe@karaf.apache.org) or [mail](mailto:dev@karaf.apache.org) the [dev@karaf.apache.org](http://mail-archives.apache.org/mod_mbox/karaf-dev/) list.
+* Report issues on [JIRA](https://issues.apache.org/jira/browse/KARAF).
+
+We also have a [contributor's guide](http://karaf.apache.org/community.html#contribute).
+
+## More Information
+
+* [Apache Karaf](http://karaf.apache.org)
+* [Apache Karaf News](http://karaf.apache.org/news.html)
+* [Apache Karaf Download](http://karaf.apache.org/download.html)
+* [Apache Karaf Documentation](http://karaf.apache.org/documentation.html)
+* [Apache Karaf Community](http://karaf.apache.org/community.html)
+* [Apache Software Foundation](https://www.apache.org)
+
+Many thanks for using Apache Karaf.
+
+**The Apache Karaf Team**