Floodlight OpenFlow Controller (OSS)
====================================

Attention!
----------

As of August 2018, the Floodlight mailing list has moved to [[email protected]](mailto:[email protected])! Archives and the new group home page [can be found here](https://groups.io/g/floodlight). Please see [Documentation and Support](#Documentation-and-Support) below for up-to-date support information.

Build Status
------------

[![Build Status](https://travis-ci.org/floodlight/floodlight.svg?branch=master)](https://travis-ci.org/floodlight/floodlight)

What is Floodlight?
-------------------

Floodlight is the leading open source OpenFlow controller. It is [supported by a community of developers](https://floodlight.atlassian.net/wiki/display/floodlightcontroller/Authors+and+Contributors), including a number of engineers from [Big Switch Networks](http://www.bigswitch.com/).

What is OpenFlow?
-----------------

OpenFlow is a open standard managed by Open Networking Foundation. It specifies a protocol by which a remote controller can modify the behavior of networking devices through a well-defined “forwarding instruction set”. Floodlight is designed to work with the growing number of switches, routers, virtual switches, and access points that support the OpenFlow standard.

Getting Started
---------------

The quickest way to use Floodlight is to start with our [pre-built VM](https://floodlight.atlassian.net/wiki/spaces/floodlightcontroller/pages/8650780/Floodlight+VM), which includes the controller, IDE, and everything you need to use Floodlight and/or start developing. You can also deploy and develop with Floodlight [in your own environment](https://floodlight.atlassian.net/wiki/spaces/floodlightcontroller/pages/1343544/Installation+Guide).

If you are a developer and are looking for project ideas, please take a look at [our current issues](https://github.com/floodlight/floodlight/issues). They are a great way to get started developing with Floodlight and provide a concrete way in which to [give back](#Contribution)!

Documentation and Support
-------------------------

Ready to get started using Floodlight? The [Floodlight wiki](https://floodlight.atlassian.net/wiki/spaces/floodlightcontroller/overview) contains user and developer documentation, as well as helpful tutorials from beginner to advanced.

Do you have a question, comment, or a great idea you'd like to propose to the community? Please subscribe and send to our mailing list [[email protected]](mailto:[email protected]). Archives and additional content can be found on the [group homepage](https://groups.io/g/floodlight).

Contribution
------------

Floodlight is supported by contributions from developers like yourself. If you found and fixed something that needed attention or have added a feature, please consider giving back by [opening a pull request](https://github.com/floodlight/floodlight/pulls). We value each and every contribution, no matter how large or how small.

If you have found a bug or have a feature request, please send a note to [[email protected]](mailto:[email protected]) and [open a issue](https://github.com/floodlight/floodlight/issues) to track it. If you are able to give back by addressing the issue yourself, please read the above and thank you! If you are unable to contribute a solution, following these simple steps will allow someone the opportunity to do so.

Interested in contributing but don't know where to start? Check out and consider addressing any of [our current issues](https://github.com/floodlight/floodlight/issues).

Authors and Contributors
------------------------

Thank you to [all who have contributed](https://floodlight.atlassian.net/wiki/display/floodlightcontroller/Authors+and+Contributors) to Floodlight! Please reach out if we have missed you, so that you can be added to this growing list.