Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.55 KB
Raw

Contributing guide

Hi! We're really excited that you're interested in contributing! Before submitting your contribution, please read through the following guide.

General guidelines

  • Bug fixes and changes discussed in the existing issues are always welcome.
  • For new ideas, please open an issue to discuss them before sending a PR.
  • Make sure your PR passes npm test and has appropriate commit messages.

Project setup

In order to run the Globalping API locally you will need Node.js 20 and Redis with RedisJSON module and MariaDB. All of them are included in docker-compose.yml file. You will also need to run a development instance of the Globalping Probe at the same time when testing.

The API uses 3000 port by default. This can be overridden by PORT environment variable.

You can run the project by following these steps:

  1. Clone this repository.
  2. docker-compose up -d - Run Redis and MariaDB
  3. npm install && npm run download:files
  4. Run npm run start:dev

Once the API is live, you can spin up a probe instance by running as described at https://github.com/jsdelivr/globalping-probe/blob/master/CONTRIBUTING.md.

Environment variables

  • PORT=3000 environment variable can start the API on another port (default is 3000)
  • FAKE_PROBE_IP=1 environment variable can be used to make debug easier. When defined, every Probe that connects to the API will get an IP address from the list of predefined "real" addresses.

Testing

A single command to run everything: npm test

To run a specific linter or a test suite, please see the scripts section of package.json.

Most IDEs have plugins integrating the used linter (eslint), including support for automated fixes on save.

Production config

Environment variables

  • ELASTIC_APM_SERVER_URL={value} used in production to send APM metrics to elastic
  • ELASTIC_APM_SECRET_TOKEN={value} used in production to send APM metrics to elastic
  • ELASTIC_SEARCH_URL={value} used in production to send logs to elastic
  • FAKE_PROBE_IP=1 used in development to use a random fake ip assigned by the API
  • ADMIN_KEY={value} used to access additional information over the API
  • SYSTEM_API_KEY={value} used for integration with the dashboard
  • SERVER_SESSION_COOKIE_SECRET={value} used to read the shared session cookie
  • DB_CONNECTION_HOST, DB_CONNECTION_USER, DB_CONNECTION_PASSWORD, and DB_CONNECTION_DATABASE database connection details