This repository contains an implementation of the Hub-of-All-Things HAT Microserver project.
The current project version is 2.6.9: HAT 2.6.9.
The Hub-of-All-Things is a HAT Microserver for individuals to own, control and share their data.
A Personal Microserver (“the HAT”) is a personal single tenant (“the individual self”) technology system that is fully individual self-service, to enable an individual to define a full set of “meta-data” defined as a specific set of personal data, personal preferences and personal behaviour events.
The HAT enables individuals to share the correct information (quality and quantity), with the correct people, in the correct situations for the correct purposes and to gain the benefits.
This HAT Microserver implementation is written in Scala (2.12.11) uses the following technology stack:
> git clone https://github.com/Hub-of-all-Things/HAT2.0.git
> cd HAT2.0
> git submodule init
> git submodule update
127.0.0.1 bobtheplumber.hat.org
127.0.0.1 bobtheplumber.example.com
> cd <DIRECTORY_YOU_CHECKED_OUT_INTO>/deployment/docker
> docker-compose up
When the build finishes, open https://bobtheplumber.example.com:9001
in a browser.
Standard account login password is testing
.
HAT runs as a combination of a backing PostgreSQL database (with a public schema for flattened data storage) and a software stack that provides logic to work with the schema using HTTP APIs.
To run it from source in a development environment two sets of tools are required:
To launch the HAT, follow these steps:
localhost
:
> createdb testhatdb1
> createuser testhatdb1
> psql postgres -c "GRANT CREATE ON DATABASE testhatdb1 TO testhatdb1"
> make dev
/etc/hosts
file. This will make sure when you go to the defined address from your machine you will be pointed back to your own machine. E.g.:
127.0.0.1 bobtheplumber.hat.org
127.0.0.1 bobtheplumber.example.com
> make run-dev
You're all set!
Your best source of information on how the development environment could
be customised is the hat/conf/dev.conf
configuration file. Make sure you
run the project locally with the configuration enabled (using the steps above)
or it will just show you the message that the HAT could not be found.
Among other things, the configuration includes:
Specifically, it has 4 major sections:
play.modules {
enabled += "org.hatdex.hat.modules.DevHatInitializationModule"
}
devhatMigrations = [
"evolutions/hat-database-schema/11_hat.sql",
"evolutions/hat-database-schema/12_hatEvolutions.sql",
"evolutions/hat-database-schema/13_liveEvolutions.sql",
"evolutions/hat-database-schema/14_newHat.sql"]
devhats
list sets out the list of HATs that are served by the current server, for
each including owner details to be initialised with and database access
credentials. Each specified database must exist before launching the server
but are initialised with the right schema at start timehat
section lists all corresponding HAT configurations to serve, here
you could change the HAT domain name, owner's email address or public/private
keypair used by the HAT for its token operationsWe have put together a docker-compose file that will allow you to run a PostgreSQL node and a HAT node easily.
> git clone https://github.com/Hub-of-all-Things/HAT2.0.git
> cd HAT2.0
> git submodule init
> git submodule update
> cd deployment/docker
> docker-compose up
> open [https://bobtheplumber.example:9001](https://bobtheplumber.example:9001)
HAT including HAT Schema and API is licensed under AGPL - GNU AFFERO GENERAL PUBLIC LICENSE