8000 Add documentation for the sandbox · Issue #2312 · coreruleset/coreruleset · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add documentation for the sandbox #2312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
5 tasks done
lifeforms opened this issue Nov 15, 2021 · 8 comments
Closed
5 tasks done

Add documentation for the sandbox #2312

lifeforms opened this issue Nov 15, 2021 · 8 comments
Assignees
@lifeforms
Labels
👍 Feature Request

Comments

@lifeforms
Copy link
Member
lifeforms commented Nov 15, 2021 •
edited
Loading

Motivation

Add documentation for the sandbox. I've started on it, but did not manage to finish. the README of the sandbox is nice, so I think I can manage this on my own, with a review.

Proposed solution

  • An explanation
  • Example curl requests
  • Advanced usage (X-CRS-parameters)
  • Explain logging.
  • Maybe add a note that we are using Openresty as a proxy which might not be totally transparent - for instance it rejects some the Apache 2.4.49/50 path injections and these requests never reach our backend.

Alternatives

None. Has to be there. :)

Additional context

N/A
@lifeforms lifeforms self-assigned this Nov 15, 2021
@fzipi fzipi mentioned this issue Dec 5, 2021
Closed
@lifeforms
8000 Copy link
Member Author

Decision: I will make a draft branch around Jan 7th and have fzipi and theMiddle review it.

@fzipi fzipi mentioned this issue Jan 2, 2022
Closed
@fzipi
Copy link
Member
fzipi commented Feb 5, 2022

@lifeforms I think this one was already pushed, right?

@lifeforms
Copy link
Member Author

Yep, it's live at https://coreruleset.org/docs/development/sandbox/

I thought it was important to have something there before the bug bounty started. But I forgot to ask you guys for a review, sorry about that.

Reviews appreciated. Do you have any comments or improvements, @fzipi @theMiddleBlue?

@fzipi
Copy link
Member
fzipi commented Feb 5, 2022

Looks good to me. The only thing is that we still didn't made the repo available, so there is no way to create issues yet. Hopefully we can solve it soon!

@lifeforms
Copy link
Member Author
lifeforms commented Feb 5, 2022 •
edited
Loading

Oh, that's right. I've fixed the issues URL to refer to the issues page on our public repo for now.

@fzipi
Copy link
Member
fzipi commented Feb 5, 2022

Then if @theMiddleBlue has nothing to add, we can close this one!

Thanks for writing this!

@theMiddleBlue
Copy link
Contributor

awesome work @lifeforms thanks!
for the "working on sandbox" we've just simplified the process to add a new backend, I'll explain it to you asap

@lifeforms
Copy link
Member Author

Ok great, just message me and I'll update it. For now, I'll close this as it's ready from a user perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lifeforms lifeforms

Labels
👍 Feature Request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fzipi @lifeforms @theMiddleBlue
0