Python JavaScript HTML CSS Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea Often occuring terms added May 25, 2018
.tx Added frontend and backend localization Jul 11, 2018
dev Added instance attribute, WiP May 19, 2018
docker Should not build frontend here Aug 13, 2017
docs Generate a graph from iso-tool docs Jul 11, 2018
frontend @ 6c251d3 Frontend ref updated Jul 22, 2018
hfos Drop username length requirement Jul 22, 2018
locale Left C in for now Jul 15, 2018
modules Allow very short usernames Jul 22, 2018
tests Fixed test Jul 22, 2018
.coveragerc Testing fixes Jun 13, 2015
.dockerignore Docker shouldn't copy build artifacts May 18, 2017
.editorconfig Added editorconfig Dec 24, 2017
.gitignore Added scratch space Oct 6, 2017
.gitmodules submodule fixed Mar 11, 2015
.landscape.yml HTH getting landscape unstuck Jul 17, 2016
.travis.yml Please, no 2.x anymore Jul 7, 2018
CHANGES.rst Initial sphinx documentation package Jun 13, 2015
CODE_OF_CONDUCT.rst CoC added Aug 24, 2017
CONTRIBUTING.rst Linked to the contribution section on readthedocs Aug 24, 2017
Dockerfile Linked default to debian dockerfile for now Feb 26, 2017
LICENSE License changed to AGPLv3, Copyright updated for 2018 Jan 5, 2018
README.rst c_ascha mentioned Jul 12, 2018
hfos_master.iml Added idea module definition Aug 15, 2017
install Fixed output redirection Jul 12, 2018
iso Merged launcher and manage tool into "iso" command Jul 7, 2018
nodestate.json Nodestates to integrate Dec 25, 2017
requirements-dev.txt Sphinx localization added Sep 3, 2017
requirements-test.txt pytest > 3.2.3 breaks tests currently Jul 12, 2018
requirements.txt Added networkx for graph resolution as dependency Jul 7, 2018
requirements27.txt Requirements updated for direct travis testing Feb 27, 2017
setup.cfg Extract backend messages for localization Feb 24, 2018
setup.py Removed tools - BREAKING CHANGE Jul 7, 2018
tox.ini Test on Python3.6 as well Feb 24, 2018

README.rst

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!

Navigation (Hackerfleet) modules

We primarily focused on navigation tools, so these are currently the 'more usable' modules. They are far from complete, see the WiP list below.

Obligatory Warning: Do not use for navigational purposes! Always have up to date paper maps and know how to use them!

Name Description
anchor Automatic anchor safety watcher
busrepeater Tool to repeat navigation data bus frames to other media
logbook Displaying and manual logging of important (nautical) events
maps (Offline) moving maps with shareable views/layers
navdata Navigational data module
nmea NMEA-0183 Navigation data and AIS bus parser
webguides Importer for skipperguide.de wiki content into the map

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/>.

-- ⛵️ 👍