Development README Page

Build Status Quality Coverage Requirements Status IRC Channel

HFOS - The Hackerfleet Operating System

A collaborative and modular infrastructure for your data.

  • Geo Information Use a sophisticated map to annotate and review geographical information
  • Vehicle support Attach a sailyacht, your camper or pack one in your backpack
  • Project planning Issue tracking for collaborative teams
  • Modular Expandable with integrated modules, build your own
  • Cloud independent Run nodes on your own infrastructure

Installation

There is more than one way of installing HFOS, see the quickstart instructions for those.

The simplest way is to use the supplied installation script:

$ sudo ./install

The installation produces a lot of output which is automatically piped into ‘output.log’. It installs all dependencies then sets up a user account and the system’s services. This assumes, that you’re not running another web server on port 443 and that your firewall is configured to allow communications on that port. HFOS modules may require additional open ports, to find out about that, read their readme files.

If you run into trouble or get any unexpected errors, contact us or try the complex installation procedure.

Modules

The system is modular, so you can install what you need and leave other things.

A lot of the included modules are still Work in Progress, so help out, if you’re interested in a powerful - cloud independent - collaboration tool suite.

General modules

These are ‘official’ Hackerfleet developed modules. If you’d like to contribute your own, ping riot@c-base.org, to get it added to the list.

Name Description
sails Web UI, compatible with all modern browsers
automat Automation for non programmers
alert User alerting and notification system
calc Integrated EtherCalc
camera Camera support
chat Integrated chat
comms Communication package
countables Count arbitrary things
dash Dashboard information system
enrol Enrollment (new user) management
equipment Equipment management
filemanager File management
garden Garden automation tools
ldap LDAP user authorization
library Library management
mesh Mesh networking
nodestate Node wide status system
polls Tool for lightweight internet voting
project Project management tools
protocols Miscellaneous communication protocols
robot RC remote control unit
shareables Shared resource blocking tool
switchboard Virtual switchboard
wiki Etherpad + Wiki = awesomeness

Many of these are not yet fully usable, so please help out and perhaps take ownership of one (or more) of them!

Work in progress

  • Full GDAL based vector chart support (Currently only raster charts)
  • Dynamic Logbook
  • GRIB data (in charts)
  • Navigation aides, planning
  • Datalog, automated navigational data exchange
  • Crew management, more safety tools
  • wireless crew network and general communications

Bugs & Discussion

Please research any bugs you find via our Github issue tracker for HFOS and report them, if they’re still unknown.

If you want to discuss distributed, opensource (or maritime) technology in general incl. where we’re heading, head over to our Github discussion forum …which is cleverly disguised as a Github issue tracker.

You can also find us here:

Note

Please be patient when using IRC, responses might take a few hours!

Contributors

Code

Assets

  • Fabulous icons by iconmonstr.com and Hackerfleet contributors

Support

  • c-base e.V. our home base, the spacestation below Berlin Mitte
  • Lassulus for hosting and nix expertise
  • Github for hosting our code
  • Travis.CI for continuous integration services
  • BrowserStack for cross device testing capabilities

License

Copyright (C) 2011-2018 riot <riot@c-base.org> and others.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

– :boat: :+1: