GithubHelp home page GithubHelp logo

roadrunner-server / roadrunner-docs Goto Github PK

View Code? Open in Web Editor NEW
24.0 7.0 68.0 1.5 MB

RoadRunner application server documentation (automatic sync to the website).

Home Page: https://roadrunner.dev/

roadrunner documentation golang php

roadrunner-docs's Introduction

NEW DOCS ARE HERE: LINK

All releases

RoadRunner is an open-source (MIT licensed) high-performance PHP application server, load balancer, and process manager. It supports running as a service with the ability to extend its functionality on a per-project basis.

Contributors

Thanks to all the people who already contributed!

roadrunner-docs's People

Contributors

alexander-schranz avatar baldinof avatar bcremer avatar bricelalu avatar butschster avatar claudiunicolaa avatar cv65kr avatar elazar avatar gennadyspb avatar guweigang avatar igorkudlo avatar kaspiman avatar lastzero avatar maximal avatar merlindiavova avatar mohammed90 avatar msmakouz avatar musahaidarird avatar nikathone avatar ovr avatar peterfox avatar rmikalkenas avatar rustatian avatar samdark avatar scullwm avatar serafimarts avatar shikachuu avatar tarampampam avatar vvval avatar wolfy-j avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

roadrunner-docs's Issues

reload.md

How can we set excluded files or patterns?

Fix the packagist package or fix documentation

I try to install roadrunner using documentation https://roadrunner.dev/docs/intro-install and find some bug.

When i do installation via composer, by running command composer require spiral/roadrunner

composer downloads spiral/roadrunner from packagist https://packagist.org/packages/spiral/roadrunner
which referenced to repo https://github.com/spiral/roadrunner-worker

So i received a light version of roadrunner without ./vendor/bin/rr, without class RoadRunner\PSR7Client and his friends.

By now i fixed it by dirty hack, adding this lines to composer.json

"repositories": [
      {
            "type": "git",
            "url": "https://github.com/spiral/roadrunner.git"
      }
]

ะกould you fix the packagist package or fix documentation?

Thanks for attention.

Link checker report

Summary

Status Count
๐Ÿ” Total 217
โœ… Successful 212
โณ Timeouts 0
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 3
โ“ Unknown 0
๐Ÿšซ Errors 2

Errors per input

Errors in docs/en/plugins/grpc.md

Errors in docs/en/php/developer.md

  • file:///github/workspace/docs/en/php/tcp:/:6001: Failed: Cannot find file file:///github/workspace/docs/en/php/tcp:/:6001

Full Github Actions output

Update docs for status endpoints

The current documentation a bit confusing because there's no explanation what is difference between /health endpoint and /ready.

Also it's good to know that if a request to these urls are wrong (wrong plugin name or even no plugin query param) you still receive a response with status code 200.

Link checker report

Summary

Status Count
๐Ÿ” Total 269
โœ… Successful 194
โณ Timeouts 0
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 0
โ“ Unknown 0
๐Ÿšซ Errors 75

Errors per input

Errors in docs/en/plugins/grpc.md

Errors in docs/en/php/worker.md

Errors in docs/en/plugins/jobs.md

Errors in docs/en/plugins/status.md

Errors in docs/en/integration/symlex.md

Errors in docs/en/workflow/temporal.md

Errors in docs/en/app-server/health.md

Errors in docs/en/docker/images.md

Errors in docs/en/integration/mezzio.md

Errors in docs/en/integration/laravel.md

Errors in docs/en/intro/install.md

Errors in docs/en/docker/ports.md

  • file:///github/workspace/docs/en/docker/tcp:/:6001: Failed: Cannot find file file:///github/workspace/docs/en/docker/tcp:/:6001

Errors in docs/en/app-server/https.md

Errors in docs/en/intro/config.md

Errors in docs/en/php/developer.md

  • file:///github/workspace/docs/en/php/tcp:/:6001: Failed: Cannot find file file:///github/workspace/docs/en/php/tcp:/:6001

Errors in docs/en/workflow/worker.md

Errors in docs/en/plugins/http.md

Errors in docs/en/php/debugging.md

Errors in docs/en/plugins/config.md

Errors in docs/en/intro/features.md

Errors in docs/en/app-server/build.md

Errors in docs/en/app-server/production.md

  • file:///github/workspace/docs/en/app-server/beep-beep/health.md: Failed: Cannot find file file:///github/workspace/docs/en/app-server/beep-beep/health.md

Errors in docs/en/intro/about.md

Errors in docs/en/plugins/tcp.md

Errors in docs/en/middleware/writing-a-middleware.md

Errors in docs/en/plugins/kv.md

Errors in docs/en/app-server/aws-lambda.md

Errors in docs/en/middleware/otel.md

Errors in docs/en/app-server/pubsub.md

Full Github Actions output

Add PhpStorm xdebug3 docs

I got the PhpStorm zero configuration debug working but not inside the IDE. https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging.html

I wish we can add docs on how to debug with PhpStorm via IDE.

export PHP_IDE_CONFIG="serverName=octane-app.test"
export XDEBUG_SESSION="mode=debug start_with_request=yes client_host=127.0.0.1 client_port=9003 idekey=PHPSTORM"

php -dvariables_order=EGPCS artisan octane:start --max-requests=250 --server=roadrunner --port=8000 --rpc-port=6001 --watch --workers=1

image

[๐Ÿงน CHORE]: Docs improvements

  • Redirect links map
  • Contributors page
  • Write about dockerisation RoadRunner server. Add an example of Dockerfile with PHP, RoadRunner and exposed ports
  • Write about HTTP middleware in docs/http-http section
  • Configuration plugin: Information about fork and custom build
  • Mention about RPC using rr client commands reset, serve, workers, jobs. A developer should pay attention on RPC ports using multiple prijects with RR on one server
  • Provide available RPC methods with description in plugin section and link From RPC page
    • Lock
    • KV
    • Service
    • Metrics
    • Jobs
    • Resetter
    • Status
    • Informer
  • Mention metrics dahsboard in plugins that support this
    • HTTP
    • gRPC
    • Centrifuge
    • Jobs
    • Temporal
  • Remove docs from roadrunner-php/lock repository and add link to RR docs
  • Remove docs from roadrunner-php/tcp repository and add link to RR docs
  • Remove docs from roadrunner-php/centrifugo repository and add link to RR docs
  • Remove config plugin from docs or make up what to writ here, because all of the information here is related to RR- configuration section
  • Write about plugin with workers
  • Mention about pool.command option to define worker script for specific plugin
    • HTTP
    • gRPC
    • Jobs
    • TCP
    • Centrifuge
    • Temporal
  • Add grafana dashboard for centrifuge plugin
  • We might also mention (if you think it worth mentioning in this section) that all of our proto-API can be found here: https://buf.build/roadrunner-server/api
  • Customization metrics
  • Mention about production mode for logger in production section

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.