Developing for Observium

Licensing

Code Contributions

By contributing code you are making a donation and forfeit all copyright to the project leader, Adam Armstrong. We will not commit personal copyrights into our codebase.

Observium is currently licensed under a modified QPL-1.0 license. We reserve the right to change the license for all or part of the code at any time.

What can to be done?

We need more/better documentation
User levels need to be worked out somewhat bit more
Code, snmp, SQL optimization
New device support!
Security audit (especially user access levels)
Conversion of old code to new standards
Gotchas and possible brokenness is indicated by FIXME comments in the code which probably need to be looked at
There are reported bugs that may need fixing, and some feature requests on the bugtracker as well.

Where to start

Check the documentation below
Check with the developers on the mailing list or in the IRC channel what you want to do, to avoid duplicating or doing unnecessary work

There is a lot of code of different ages in Observium, which has evolved through a number of different code stages. Please check with the developers first before taking something as a base to start from, as it may no longer be the preferred way of doing things!

General code structure

General code structure - Read this first!
Authentication modules

User Interface

Web UI conventions

HOWTO

Also...

Code style guide