☄️ Temporal is an easy-to-use interface into distributed and decentralized storage technologies for personal and enterprise use cases. License is currently under review.
Clone or download
Latest commit 90869e5 Nov 16, 2018
Permalink
Failed to load latest commit information.
.github .github: move COC to .github Sep 4, 2018
.scripts chore: use gox to cross-compile releases Sep 23, 2018
api api: add call to remove private network Nov 17, 2018
cmd/temporal database: extract to RTradeLtd/database Nov 13, 2018
docker added database middleware to login routes Aug 5, 2018
eh user: enable password reset, and other recovery helpers Nov 14, 2018
grpc-clients grpc: correct dialopts append, change !devmode Nov 15, 2018
mail database: extract to RTradeLtd/database Nov 13, 2018
mini chore: initial golint sanctification for all sub packages Nov 5, 2018
queue database: extract to RTradeLtd/database Nov 13, 2018
rtfs api: add configurable keystore path Nov 17, 2018
rtfscluster chore: finished golint satisfication Nov 5, 2018
rtfsp chore: initial golint sanctification for all sub packages Nov 5, 2018
rtns chore: initial golint sanctification for all sub packages Nov 5, 2018
setup chore: update ipfs install script Nov 2, 2018
test chore: cleaned up travis Nov 17, 2018
tns Merge branch 'database/extract' of github.com:RTradeLtd/Temporal into… Nov 13, 2018
utils chore: initial golint sanctification for all sub packages Nov 5, 2018
vendor chore: update config Nov 17, 2018
.gitattributes Add gitattributes for Windows Aug 31, 2018
.gitignore test: add additional assets and config for easier local api startup Oct 13, 2018
.travis.yml chore: remove travis comments Nov 17, 2018
Dockerfile dist: remove default solidity cert path from Docker image Sep 20, 2018
Gopkg.lock chore: update config Nov 17, 2018
Gopkg.toml chore: update config Nov 17, 2018
LICENSE Add MIT Sep 18, 2018
Makefile deps: revert go-ipfs-api removal Nov 13, 2018
README.md docs: fix Medium link Nov 13, 2018
codecov.yml chore: add more lenient codecov config Sep 23, 2018
temporal.yml chore: update test environment Nov 2, 2018

README.md

Temporal (Heavy WIP)

About Temporal · Web Interfaces · Usage and Features · Development · Thanks · License

GoDocs available Travis Build Status Clean code


About Temporal

Temporal is an enterprise-grade storage solution featuring an easy to consume API that can be easily integrated into your existing application stack, providing all the benefits of the distributed web, without any of the overhead that comes with running distributed storage nodes. Initially targetting the public+private IPFS network, the next release cycle will bring support for additional protocols such as Ethereum SWARM, STORJ. Temporal won't stop there and will continue to evolve as the space itself evolves. At RTrade we understand that the Blockchain and Distributed technology space evolve at an extremely quick pace so we are designing Temporal with modularity in mind so that as the space evolves we can evolve seamlessly with it.

Temporal's API comes in two flavours, hosted or on-site. Should you not have the resources to run your own distributed storage nodes and infrastructure, you can take advantage of our hosted API allowing us to manage all the storage nodes and infrastructure, so all that you have to worry about is your application and using our API; We deal with all the hardware and infrastructure failures so that you can spend your hard work focusing on releasing products, not troubleshooting infrastructure failures which drain critical development resources. If however you have the infrastructure, and technical resources you can take advantage of Temporal being open source and deploy your own Temporal infrastructure. For on-site deployments we offer special paid for installations, maintenance, upgrades, and product usage information sessions allowing you to take full advantage of the power that comes with running your own Temporal infrastructure.

Temporal is being designed with a "Plug and Play" style design such that the underlying storage protocols it connects to can be swapped in and out with other protocols at will, without having to change the overall Temporal architecture, you simply need to write the interface for whatever storage protocol you want to use and it will support it. Using your new storage protocol will be as a simple as indicating a parameter in the API call for which storage networks it should plug into. In this manner, the API itself will never have to change to support new protocols.

We have a telegram chat, feel free to join and ask any questions you may have that could not be answered by reading the documentation here. The documentation contained is fairly detailed, as all my notes are public, however it is fairly scattered and unorganized for now.

TEMPORAL is a work in progress, and current code does not represent quality of the final product. Before a production release there will be an extremely heavy review, and updates to code quality.

Web Interfaces

Temporal now has a working web interface! This provides a slick and easy way to interact with Temporal without the need for using our API. We currently have two versions of the web interface, running over regular HTTP, and one over I2P!

Please note that support for the I2P Interface is very experimental at the moment and does not offer HTTPS.

Goals

  • Provide an easy to use interface into distributed and decentralized storage technologies.
  • Educate about decentralized and distributed storage technologies
  • Introduce these new storage technologies to audiences who may have otherwise not heard of them
  • Help organizations make informed decisions about whether or not integrating distributed and decentralized storage technologies is the right thing to do for your business

How We're Different

We aren't doing an ICO, and we're not wasting our development efforts on redesigning the wheel with some new fangled storage protocol, and blockchain solution. Although we're using bleeding edge technology, we're commited to using names, and open source software that is already tested, and that has a thriving development community behind them. And finally, results matter; It is far to common in this space for companies to ask you to hand over your hand earned cash on the fleeting promise that it will lead to something, but that something is either never delivered, or extremely lack in features, and is not the original idea which was sold.

Funding

Currently the project is paid for out of pocket, and we will not be doing an ICO. Any funding received through donations, or private investment will be put to the following:

  • Infrastructure
    • Servers
    • Hard drives
    • Misc infrastructure (networking, etc..)
  • Code Audits
  • Developer Tools
  • Legal
    • Lawyers
    • Ensure we meet regulatory needs
  • Media
    • Educational resources development
  • Hiring additional talent for Temporal enterprise to bring project to completion

Should you wish to consider donations, or private investment email admin@rtradetechnologies.com.

Should you wish to contribute not just to TEMPORAL, but to the overall success of RTrade and our platform, you may purchase RTC for ETH from our RTCETH Smart Contract

Media

Channels:

Select Blog Posts:

Data Privacy

This is a huge issue and concern for any form of cloud storage. But is seldom mentioned by any of the projects promising revolutionary storage systems, global in scope. They'll talk about all the technical benefits, and features of their storage solutions which use IPFS, but data privacy isn't discussed. Data privacy is an extreme focus of RTrade, and we will not be releasing Temporal until we are absolutely certain that all data privacy laws we need to abide by, are met. This is currently one of our primary areas of focus.

Usage and Features

Spinning up a Node

Once you have a config.json set up (a template can be generated using temporal init), you can run the following commands to use docker-compose to spin up Temporal:

$> curl https://raw.githubusercontent.com/RTradeLtd/Temporal/V2/temporal.yml --output temporal.yml
$> docker-compose -f temporal.yml up

Refer to the temporal.yml documentation for more details.

API Documentation

Our API documentation is through postman

Smart Contracts

All smart contracts used by TEMPORAL can be viewed in our contracts repository

Features

  • IPNS (100%):
    • Overtime addtional IPNS functionality will be added allowing for things like automatic record republishing, however the core functionality is done!
  • IPFS (100%):
    • Overtime additional IPFS functionality will be added, however the core functionality needed to use IPFS (upload, download, etc...) is done! Both for public and private IPFS networks

Supported Technologies

Following is a list of distributed and decentralized storage technologies that Temporal currently, or plans on supporting.

IPFS (100% complete):

Temporal supports integration with the public IPFS network, and will evolve to support new features added to IPFS so that you will have the most optimal experience possible, and never suffer from inability to access the latest and greatest features due to an API that fails to evolve as the underlying technology evolves. We also have full integration with private IPFS networks.

IPNS (100% Complete):

IPNS allows for publishing of human readable names, and immutable links to changing content. IPNS integration is an optional feature with each upload to IPFS, and will allow for creation of dnslink records on our domain. Note that for the hosted API, IPNS usage alongside of IPFS pins or file uploads will incur additional charges.

As a special/unique feature, you can plug into Temporal's IPNS setup, and use us as a trusted signer of IPNS records, while also optionally taking care of the DNS configuration, storing the DNS record underneath our domain (rtradetechnologies.com) at a URL of your choice with a subdomain name of your choosing providing it is available. Should you desire that, you can tap into our automated configuration and have that all done automatically. Optionally, we can also build out a hosted, or on-premise automated solution for your own domain as well.

System Monitoring

System monitoring is done using a combination of Zabbix, and Grafana. Zabbix is used for operating system, and hardware metrics (network utilization, resource utilization, storage utilization, etc...) while Grafana is used for API and application level information for things like IPFS node statistics, API requests, etc...

All templates, and grafana graphs, as well as necessary configuration files and scripts to replicate our system monitoring backend are included in the configs/ directory of this repository. The only configurations we don't include are our email configurations.

Development

Building

Dependencies are vendored by default, so there is no need to install anything if you have the Go toolchain. Just run the following commands:

$ go get github.com/RTradeLtd/Temporal
$ cd $GOPATH/src/github.com/RTradeLtd/Temporal
$ make

Due to our very large dependency tree which is vendored, running the initial go get will take a very long time, anywhere from 15 -> 30 minutes depending on your computer processing capabilities, internet connection, and such. This isn't likely to change anytime soon, so patience is greatly appreciated!

Running Locally

To run the API locally:

$ make testenv
$ make api

Testing

Most tests can be run using the following commands:

$ make testenv
$ make test

This requires Docker running and docker-compose installed.

To run the full suite of tests, more advanced setup and configuration is required. If all the prerequisites are set up, you can execute the tests using make test-all.

Linting

The following command will run some lint checks:

$ make lint

This requires golint and spellcheck to be installed.

Vendoring

To update or rebuild the dependencies, run:

$ make vendor

This requires the GX dependency management tool to be installed.

Repository Contents

  • api/
    • This contains the API related code to temporal, as is the primary interface for interaction with temporal
    • all web frontends, applications, etc... use this api
  • api/middleware
    • This is middleware used by the API and handles common functionality such as database connection parameters, rabbitmq parameters, etc...
  • cli
    • basic terminal-based cli application
  • configs
    • parent directory contains systemd service files
  • configs/grafana
    • JSON files for our grafana graphs
  • contracts
    • solidity source code files for temporal smart contracts
  • database
    • this is the package used by temporal for interacting with our database backend
  • docs
    • contains all non-readme documentation
  • models
    • models used by temporal
  • queue
    • all queue related code for rabbitmq and ipfs pubsub queue
  • rtfs
    • contains temporal code for interacting with ipfs nodes
  • rtfs_cluster
    • contains temporal code for interacting with the ipfs cluster
  • server
    • contains server related code for interacting with the ethereum blockchain
    • this will eventually be broken up into three seperate folders corresponding to each of the smart contracts
  • utils
    • contains utility code used by temporal
  • cmd/temporal
    • contains the temporal command line application

Thanks

Without open source, TEMPORAL wouldn't be possible, as such we would like to extend our thanks to all of the open source projects for which TEMPORAL depends on. If you notice any are missing from the list below please open an issue and we will add it to the list:

License

As Temporal is a large and complex project, licensing is a complex subject. This is something we are actively looking into, however to minimize issues in the interm, we are defaulting to an MIT license. This will more than likely change in the future, however we want to make sure that the license we settle on for when we fully launch will be the right one.

FOSSA Status