Home

Giovanni Pellerano edited this page Nov 8, 2017 · 226 revisions

GlobaLeaks's Developer Documentation

GlobaLeaks is an open-source, free software intended to enable secure and anonymous whistleblowing initiatives developed by the Hermes Center for Transparency and Digital Human Rights.

The following sections form the GlobaLeaks's Developer Documentation.

For the user manual refer to the GlobaLeaks's User Manual.

Software Security

The security and anonymity features built into GlobaLeaks:

Software Development

Consult first the Glossary and familiarise yourself with the terms used. For a general understanding of the project, you can read the GlobaLeaks Project Plan. A deeper understanding of GlobaLeaks' architecture can be attained by reading Architecture Document.

Software Development Guidelines

If you plan to contribute to the development of GlobaLeaks, the following setup and style guides is suggested reading:

Software Internationalization

An effort in coordination with the Localization Lab to localize GlobaLeaks in more than 20 languages is ongoing.

To read more about how translation works and how you can help, visit the Localization Lab's translator guide.

Unit-Testing

The GlobaLeaks codebase is continuously and comprehensively unit tested thanks to both Travis CI, Coveralls, and Codacy.

Build Status

Branch Build status Browser compatibility
master Build Status Browser Status
devel Build Status Browser Status

Code quality:

Branch Codacy Coveralls
master Codacy Badge Coverage Status
devel Codacy Badge Coverage Status

Release Procedure

The Release Procedure outlines preparation and publishing of new versions of GlobaLeaks.

Releases Archive

GlobaLeaks releases are archived in our official deb repository: deb.globaleaks.org

Software License

GlobaLeaks is free software released under the GNU Affero General Public License v3.

GlobaLeaks makes use of a plethora of other free software projects. For a list of software used in GlobaLeaks refer to the Technology Selection.

Project Reporting

Radio Free Asia Freedom 2 Connect Grant

The following page lists the monthly reports concerning the state of advancement of GlobaLeaks during the period financed by the Freedom 2 Connect Grant – June 2012 to April 2013.

Open Technology Fund Project

This page following page lists the monthly reports concerning the state of advancement of GlobaLeaks during the period financed by the OTF Project – July 2014 to January 2016 and OTF Project 2017-2018 (ongoing).