blob: 07740efd5f7f6f1d75fb4d027c2a754dec454694 [file] [log] [blame]
Guillaume Nodet91fab3b2009-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
18Welcome to Apache ServiceMix Kernel
19====================================
20Apache ServiceMix Kernel is a small OSGi based kernel which provides a
21lightweight container onto which various bundles can be deployed.
22
23The following features are included:
24 * Hot deployment: ServiceMix Kernel supports hot deployment of OSGi bundles by monitoring
25 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
30 service. Such configuration can be defined in ServiceMix Kernel using property files inside
31 the [home]/etc directory. These configurations are monitored and changes on the properties
32 files will be propagated to the services.
33 * Logging System: using a centralized logging back end supported by Log4J, ServiceMix Kernel
34 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.
37 * Native OS integration: ServiceMix Kernel can be integrated into your own Operating System as
38 a service so that the lifecycle will be bound to your Operating System.
39 * Extensible Shell console: ServiceMix features a nice text console where you can manage the
40 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
44 * Managing instances: ServiceMix Kernel provides simple commands for managing instances of
45 ServiceMix Kernel. You can easily create, delete, start and stop instances of ServiceMix
46 Kernel through the console.
47
48Getting Started
49===============
50For an Apache ServiceMix Kernel source distribution, please read
51BUILDING.txt for instructions on building Apache ServiceMix Kernel.
52
53For an Apache ServiceMix Kernel binary distribution, please read
54RELEASE-NOTES.txt for installation instructions and list of supported
55and unsupported features.
56
57Alternatively, you can also find out how to get started here:
58 http://servicemix.apache.org/kernel/
59
60If you need more help try talking to us on our mailing lists
61 http://servicemix.apache.org/mailing-lists.html
62
63If you find any issues with ServiceMix Kernel, please submit reports
64with JIRA here:
65 http://issues.apache.org/activemq/browse/SMX4KNL
66
67We welcome contributions, and encourage you to get involved in the
68ServiceMix community. If you'd like to learn more about how you can
69contribute, please see:
70 http://servicemix.apache.org/contributing.html
71
72Many thanks for using Apache ServiceMix.
73
74
75The ServiceMix Team
76http://servicemix.apache.org/team.html