0f1fd00c3c3af828a4f343dcadf59e5a74e77cbe
[netconf.git] / README.md
1 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.netconf/netconf-artifacts/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.netconf/netconf-artifacts)
2 [![Javadocs](https://www.javadoc.io/badge/org.opendaylight.netconf/restconf-common.svg)](https://www.javadoc.io/doc/org.opendaylight.netconf/restconf-common)
3 [![License](https://img.shields.io/badge/License-EPL%201.0-blue.svg)](https://opensource.org/licenses/EPL-1.0)
4
5 # OpenDaylight NETCONF/RESTCONF implementation
6
7 This project hosts implementations of protocols defined by the [IETF NETCONF Working Group](https://datatracker.ietf.org/wg/netconf/about/).
8 In particular, it implements:
9 * [Network Configuration Protocol (NETCONF)](https://www.rfc-editor.org/rfc/rfc6241)
10 * [RESTCONF Protocol](https://www.rfc-editor.org/rfc/rfc8040)
11
12 Your immediate interests may be:
13 * Documentation is in [docs](https://docs.opendaylight.org/projects/netconf/en/latest/index.html)
14 * Ready-to-applications are in [apps](apps/README.md)
15
16 Other than that, you may delve into gory details:
17 * basic project infrastructure, including [the BOM](artifacts), [Karaf features](features),
18 [Dynamic Karaf distribution](karaf), [Static Karaf distribution](karaf-static) and the [Common Maven Parent](parent)
19 * [YANG models](model) relating to this project
20 * [Transport layer](transport) implementation
21 * [Low-level](protocol) protocol implementations
22 * [High-level](plugins) protocol integrations
23 * [NETCONF Key store](keystore) implementation
24 * [NETCONF Trust store](truststore) implementation
25 * [applications](apps/README.md) for both end users and integrators