@nearform/trail-fastify-server
Advanced tools
Server running Fastify plugin for the audit trail logging service
trail-fastify-server is a ready to use Fastify server with the trail-fastify-plugin registered.
It also provides a local instance of Swagger UI to easily check the REST API documentation.
To install via npm:
npm install @nearform/trail-fastify-server
npx run trail-fastify-server
This will start a server on localhost:8080. Swagger UI documentation is accessible at http://localhost:8080/documentation/.
The server looks for the following environment variables:
TRAIL_DB_HOST: The hostname for the trail database.TRAIL_DB_PORT: The port number for the trail database.TRAIL_DB_NAME: The name of the trail database.TRAIL_DB_USERNAME: The username for the trail database.TRAIL_DB_PASSWORD: The password for the trail database.TRAIL_DB_POOL_SIZE: The size of the trail DB pool.TRAIL_DB_TIMEOUT: The trail database idle timeout, in milliseconds.TRAIL_HTTP_HOST: The hostname the HTTP server is bound to.TRAIL_HTTP_PORT: The port the HTTP server is bound to.TRAIL_CORS_ORIGIN: The value for Access-Control-Allow-Origin header as per fastify-cors plugin.TRAIL_USE_REST_API: Flag indicating whether to mount the REST API.TRAIL_USE_GRAPHQL: Flag indicating whether to mount the graphql endpoint.These can also be defined using a .env file.
The server also takes the following command line options:
--dbHost <host>: The hostname for the trail database. Defaults to localhost.--dbPort <port>: The port number for the trail database. Defaults to 5432.--dbName <name>: The name of the trail database. Defaults to trails.--dbUsername <user>: The username for the trail database. Defaults to postgres.--dbPassword <password>: The password for the trail database. Defaults to postgres.--dbPoolsize <size>: The size of the trail DB pool. Defaults to 10.--dbTimeout <ms>: The trail database idle timeout, in milliseconds. Defaults to 30000.--httpHost <host>: The hostname the HTTP server is bound to. Defaults to localhost.--httpPort <port>: The port the HTTP server is bound to. Defaults to 8080.--corsOrigin <origin>: set value for Access-Control-Allow-Origin header. Defaults to ``.--useRESTAPI: Flag indicating whether to start with the Trail's REST API. Defaults to true.--useGraphql: Flag indicating whether to start with the graphql query endpoint. Defaults to true.Command line options take precedence over environment settings.
Copyright nearForm Ltd 2020. Licensed under MIT.
6.0.0 (2021-05-03)
FAQs
Server running Fastify plugin for the audit trail logging service
We found that @nearform/trail-fastify-server demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 35 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm's new minimumReleaseAge setting delays package updates to prevent supply chain attacks, with other tools like Taze and NCU following suit.
Security News
The Rust Security Response WG is warning of phishing emails from rustfoundation.dev targeting crates.io users.
Product
Socket now lets you customize pull request alert headers, helping security teams share clear guidance right in PRs to speed reviews and reduce back-and-forth.