paragonie/gossamer-server

Standalone REST API server for retrieving updates.

dev-master 2021-08-12 22:57 UTC

Requires

• php: ^7.3|^8
• ext-json: *
• guzzlehttp/guzzle: ^6
• guzzlehttp/psr7: ^1
• nikic/fast-route: ^1
• paragonie/libgossamer: ^0.4|^1
• psr/http-message: ^1

Requires (Dev)

• phpunit/phpunit: ^7|^8|^9
• vimeo/psalm: ^3|^4

ISC

• Paragon Initiative Enterprises

README

Standalone REST API for Gossamer.

Setup

First, clone with Git then install the dependencies.

composer update --no-dev

Next, you'll need to configure your instance. You can do this manually, or use the bin/configure script to setup your database and Chronicles.

Once your database is configured, run bin/make to create the necessary database schema (tables, indexes).

Once your database and Chronicles are both configured, run bin/sync to do the initial data synchronization.

Finally, setup a cronjob to run bin/sync fairly regularly (at least once per hour).