yggverse/yggstate

This package is abandoned and no longer maintained. No replacement package was suggested.

Yggdrasil Network Explorer

dev-main 2023-11-29 22:27 UTC

This package is auto-updated.

Last update: 2023-12-29 22:36:43 UTC


README

Yggdrasil Network Explorer

Overview

Dashboard

https://github.com/YGGverse/YGGstate/tree/main/media

Requirements

php8^
php-pdo
php-mysql
php-memcached
memcached
sphinxsearch

Database model

Database model

Installation

  • git clone https://github.com/YGGverse/YGGstate.git
  • cd YGGstate
  • composer install

Setup

  • Server configuration /example/environment
  • The web root dir is /src/public
  • Deploy the database using MySQL Workbench project presented in the /database folder
  • Install Sphinx Search Server
  • Install GeoLite2 DB to /src/storage or provide alternative path in configuration file
  • Configuration examples presented at /config folder
  • Set up the /src/crontab by following example
  • Set up server as yggdrasil public peer to start remote connections tracking

Contribute

Please make new branch for each PR

git checkout main
git checkout -b my-pr-branch-name

Roadmap

API

  • trackers
  • peers

Donate to contributors

License

Components

Feedback

Feel free to share your ideas and bug reports!

Community

See also