blob: d6531b740e8856c2afdcacd9f9f5ee42439ece3c [file] [log] [blame]
Guillaume Nodet05fac962009-04-27 10:01:58 +00001/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000018Welcome to Apache Felix Karaf
Guillaume Nodet05fac962009-04-27 10:01:58 +000019====================================
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000020Apache Felix Karaf is a small OSGi based kernel which provides a
Guillaume Nodet05fac962009-04-27 10:01:58 +000021lightweight container onto which various bundles can be deployed.
22
23The following features are included:
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000024 * Hot deployment: Karaf supports hot deployment of OSGi bundles by monitoring
Guillaume Nodet05fac962009-04-27 10:01:58 +000025 jar files inside the [home]/deploy directory. Each time a jar is copied in this folder,
26 it will be installed inside the runtime. You can then update or delete it and changes will
27 be handled automatically. In addition, the Kernel also supports exploded bundles and custom
28 deployers (a spring one is included by default).
29 * Dynamic configuration: Services are usually configured through the ConfigurationAdmin OSGi
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000030 service. Such configuration can be defined in Karf using property files inside
Guillaume Nodet05fac962009-04-27 10:01:58 +000031 the [home]/etc directory. These configurations are monitored and changes on the properties
32 files will be propagated to the services.
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000033 * Logging System: using a centralized logging back end supported by Log4J, Karaf
Guillaume Nodet05fac962009-04-27 10:01:58 +000034 supports a number of different APIs (JDK 1.4, JCL, SLF4J, Avalon, Tomcat, OSGi)
35 * Provisioning: Provisioning of libraries or applications can be done through a number of
36 different ways, by which they will be downloaded locally, installed and started.
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000037 * Native OS integration: Karaf can be integrated into your own Operating System as
Guillaume Nodet05fac962009-04-27 10:01:58 +000038 a service so that the lifecycle will be bound to your Operating System.
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000039 * Extensible Shell console: Karaf features a nice text console where you can manage the
Guillaume Nodet05fac962009-04-27 10:01:58 +000040 services, install new applications or libraries and manage their state. This shell is easily
41 extensible by deploying new commands dynamically along with new features or applications.
42 * Remote access: use any SSH client to connect to the kernel and issue commands in the console
43 * Security framework based on JAAS
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000044 * Managing instances: Karaf provides simple commands for managing instances of Karaf.
45 You can easily create, delete, start and stop instances of Karaf through the console.
Guillaume Nodet05fac962009-04-27 10:01:58 +000046
47Getting Started
48===============
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000049For an Apache Felix Karaf source distribution, please read
Guillaume Nodet23a0f3d2009-09-18 20:14:54 +000050BUILDING for instructions on building Apache Felix Karaf.
Guillaume Nodet05fac962009-04-27 10:01:58 +000051
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000052For an Apache Felix Karaf binary distribution, please read
Guillaume Nodet23a0f3d2009-09-18 20:14:54 +000053RELEASE-NOTES for installation instructions and list of supported
Guillaume Nodet05fac962009-04-27 10:01:58 +000054and unsupported features.
55
56Alternatively, you can also find out how to get started here:
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000057 http://felix.apache.org/site/apache-felix-karaf.html
Guillaume Nodet05fac962009-04-27 10:01:58 +000058
59If you need more help try talking to us on our mailing lists
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000060 http://felix.apache.org/site/mailinglists.html
Guillaume Nodet05fac962009-04-27 10:01:58 +000061
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000062If you find any issues with Apache Felix Karaf, please submit reports
Guillaume Nodet05fac962009-04-27 10:01:58 +000063with JIRA here:
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000064 http://issues.apache.org/jira/browse/FELIX
Guillaume Nodet05fac962009-04-27 10:01:58 +000065
66We welcome contributions, and encourage you to get involved in the
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000067Felix community. If you'd like to learn more about how you can
Guillaume Nodet05fac962009-04-27 10:01:58 +000068contribute, please see:
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000069 http://felix.apache.org/site/contributing.html
Guillaume Nodet05fac962009-04-27 10:01:58 +000070
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000071Many thanks for using Apache Felix Karaf.
Guillaume Nodet05fac962009-04-27 10:01:58 +000072
73
Guillaume Nodet1becb5b2009-05-04 07:56:47 +000074The Felix Team
75