Skip to content

Otoroshi advanced features guide - #877

Open
Juju-archy wants to merge 180 commits into
mainfrom
guide-feature-otoroshi
Open

Juju-archy wants to merge 180 commits into
mainfrom
guide-feature-otoroshi

docs: add Otoroshi advanced features guide (WAF, reverse proxy, rate …

4b86c5d
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
GitHub Actions / vale completed Aug 24, 2026 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (64)

content/guides/otoroshi.md|22 col 13| Use 'app' instead of 'Application'.
content/guides/otoroshi.md|24 col 36| Use 'open source' instead of 'open-source'.
content/guides/otoroshi.md|24 col 105| Spell out 'OWASP', if it's unfamiliar to the audience.
content/guides/otoroshi.md|28 col 14| 'Create' should be in lowercase.
content/guides/otoroshi.md|43 col 28| 'Enables' should be in lowercase.
content/guides/otoroshi.md|43 col 94| In general, use active voice instead of passive voice ('are evaluated').
content/guides/otoroshi.md|44 col 51| 'Rule' should be in lowercase.
content/guides/otoroshi.md|45 col 22| 'Regex' should be in lowercase.
content/guides/otoroshi.md|45 col 22| Use 'regular expression' instead of 'Regex'.
content/guides/otoroshi.md|46 col 19| 'Mandatory' should be in lowercase.
content/guides/otoroshi.md|47 col 19| 'Evaluation' should be in lowercase.
content/guides/otoroshi.md|48 col 16| 'Disruptive' should be in lowercase.
content/guides/otoroshi.md|49 col 22| 'HTTP' should be in lowercase.
content/guides/otoroshi.md|50 col 15| 'Records' should be in lowercase.
content/guides/otoroshi.md|51 col 28| 'Message' should be in lowercase.
content/guides/otoroshi.md|54 col 71| Don't put a space before or after a dash.
content/guides/otoroshi.md|54 col 120| Use the Oxford comma in ', variables and actions'.
content/guides/otoroshi.md|55 col 12| Spell out 'OWASP', if it's unfamiliar to the audience.
content/guides/otoroshi.md|55 col 91| Don't put a space before or after a dash.
content/guides/otoroshi.md|55 col 128| Spell out 'OWASP', if it's unfamiliar to the audience.
content/guides/otoroshi.md|55 col 134| Spell out 'CRS', if it's unfamiliar to the audience.
content/guides/otoroshi.md|58 col 17| 'Each' should be in lowercase.
content/guides/otoroshi.md|58 col 133| Avoid using 'will'.
content/guides/otoroshi.md|58 col 146| Spell out 'WASM', if it's unfamiliar to the audience.
content/guides/otoroshi.md|62 col 12| 'Using' should be in lowercase.
content/guides/otoroshi.md|62 col 151| Did you really mean 'balancer's'?
content/guides/otoroshi.md|64 col 32| In general, use active voice instead of passive voice ('are required').
content/guides/otoroshi.md|64 col 63| Use 'aren't' instead of 'are not'.
content/guides/otoroshi.md|64 col 104| Spell out 'WASM', if it's unfamiliar to the audience.
content/guides/otoroshi.md|67 col 14| 'Create' should be in lowercase.
content/guides/otoroshi.md|71 col 55| Avoid using 'addon'.
content/guides/otoroshi.md|71 col 55| Did you really mean 'addon'?
content/guides/otoroshi.md|73 col 44| Avoid using 'will'.
content/guides/otoroshi.md|77 col 92| In general, use active voice instead of passive voice ('is used').
content/guides/otoroshi.md|88 col 19| 'Standard' should be in lowercase.
content/guides/otoroshi.md|89 col 12| 'Raw' should be in lowercase.
content/guides/otoroshi.md|90 col 13| 'Modern' should be in lowercase.
content/guides/otoroshi.md|90 col 20| Spell out 'RPC', if it's unfamiliar to the audience.
content/guides/otoroshi.md|98 col 55| Avoid using 'addon'.
content/guides/otoroshi.md|98 col 55| Did you really mean 'addon'?
content/guides/otoroshi.md|111 col 15| 'The' should be in lowercase.
content/guides/otoroshi.md|111 col 106| Avoid using 'will'.
content/guides/otoroshi.md|113 col 14| 'The' should be in lowercase.
content/guides/otoroshi.md|116 col 103| In general, use active voice instead of passive voice ('is used').
content/guides/otoroshi.md|134 col 17| 'Number' should be in lowercase.
content/guides/otoroshi.md|135 col 18| 'Time' should be in lowercase.
content/guides/otoroshi.md|136 col 20| 'IP' should be in lowercase.
content/guides/otoroshi.md|159 col 19| 'Limit' should be in lowercase.
content/guides/otoroshi.md|160 col 16| 'Different' should be in lowercase.
content/guides/otoroshi.md|161 col 13| 'Authenticated' should be in lowercase.
content/guides/otoroshi.md|162 col 22| 'Advanced' should be in lowercase.
content/guides/otoroshi.md|170 col 15| 'Route' should be in lowercase.
content/guides/otoroshi.md|179 col 21| 'Public' should be in lowercase.
content/guides/otoroshi.md|179 col 49| Avoid using 'addon'.
content/guides/otoroshi.md|179 col 49| Did you really mean 'addon'?
content/guides/otoroshi.md|186 col 20| 'Stable' should be in lowercase.
content/guides/otoroshi.md|186 col 44| Use 'for example' instead of 'e.g.'.
content/guides/otoroshi.md|241 col 15| 'Service' should be in lowercase.
content/guides/otoroshi.md|285 col 15| 'Client' should be in lowercase.
content/guides/otoroshi.md|291 col 27| 'Routes' should be in lowercase.
content/guides/otoroshi.md|292 col 15| 'Distributes' should be in lowercase.
content/guides/otoroshi.md|293 col 11| 'Randomly' should be in lowercase.
content/guides/otoroshi.md|294 col 18| 'Routes' should be in lowercase.
content/guides/otoroshi.md|301 col 3| Spell out 'OWASP', if it's unfamiliar to the audience.

Filtered Findings (0)

Annotations

Check warning on line 22 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L22 <Google.WordListCase>(https://developers.google.com/style/word-list)

Use 'app' instead of 'Application'.
Raw output
{"message":"Use 'app' instead of 'Application'.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":22,"column":13},"end":{"line":22,"column":24}}},"severity":"WARNING","code":{"value":"Google.WordListCase","url":"https://developers.google.com/style/word-list"}}

Check warning on line 24 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L24 <Google.WordListCase>(https://developers.google.com/style/word-list)

Use 'open source' instead of 'open-source'.
Raw output
{"message":"Use 'open source' instead of 'open-source'.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":24,"column":36},"end":{"line":24,"column":47}}},"severity":"WARNING","code":{"value":"Google.WordListCase","url":"https://developers.google.com/style/word-list"}}

Check notice on line 24 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L24 <Google.Acronyms>(https://developers.google.com/style/abbreviations)

Spell out 'OWASP', if it's unfamiliar to the audience.
Raw output
{"message":"Spell out 'OWASP', if it's unfamiliar to the audience.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":24,"column":105},"end":{"line":24,"column":110}}},"severity":"INFO","code":{"value":"Google.Acronyms","url":"https://developers.google.com/style/abbreviations"}}

Check warning on line 28 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L28 <Google.Colons>(https://developers.google.com/style/colons)

'Create' should be in lowercase.
Raw output
{"message":"'Create' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":28,"column":14},"end":{"line":28,"column":20}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 43 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L43 <Google.Colons>(https://developers.google.com/style/colons)

'Enables' should be in lowercase.
Raw output
{"message":"'Enables' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":43,"column":28},"end":{"line":43,"column":35}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check notice on line 43 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L43 <Google.Passive>(https://developers.google.com/style/voice)

In general, use active voice instead of passive voice ('are evaluated').
Raw output
{"message":"In general, use active voice instead of passive voice ('are evaluated').","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":43,"column":94},"end":{"line":43,"column":107}}},"severity":"INFO","code":{"value":"Google.Passive","url":"https://developers.google.com/style/voice"}}

Check warning on line 44 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L44 <Google.Colons>(https://developers.google.com/style/colons)

'Rule' should be in lowercase.
Raw output
{"message":"'Rule' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":44,"column":51},"end":{"line":44,"column":55}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 45 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L45 <Google.Colons>(https://developers.google.com/style/colons)

'Regex' should be in lowercase.
Raw output
{"message":"'Regex' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":45,"column":22},"end":{"line":45,"column":27}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 45 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L45 <Google.WordListCase>(https://developers.google.com/style/word-list)

Use 'regular expression' instead of 'Regex'.
Raw output
{"message":"Use 'regular expression' instead of 'Regex'.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":45,"column":22},"end":{"line":45,"column":27}}},"severity":"WARNING","code":{"value":"Google.WordListCase","url":"https://developers.google.com/style/word-list"}}

Check warning on line 46 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L46 <Google.Colons>(https://developers.google.com/style/colons)

'Mandatory' should be in lowercase.
Raw output
{"message":"'Mandatory' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":46,"column":19},"end":{"line":46,"column":28}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 47 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L47 <Google.Colons>(https://developers.google.com/style/colons)

'Evaluation' should be in lowercase.
Raw output
{"message":"'Evaluation' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":47,"column":19},"end":{"line":47,"column":29}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 48 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L48 <Google.Colons>(https://developers.google.com/style/colons)

'Disruptive' should be in lowercase.
Raw output
{"message":"'Disruptive' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":48,"column":16},"end":{"line":48,"column":26}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 49 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L49 <Google.Colons>(https://developers.google.com/style/colons)

'HTTP' should be in lowercase.
Raw output
{"message":"'HTTP' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":49,"column":22},"end":{"line":49,"column":26}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 50 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L50 <Google.Colons>(https://developers.google.com/style/colons)

'Records' should be in lowercase.
Raw output
{"message":"'Records' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":50,"column":15},"end":{"line":50,"column":22}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 51 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L51 <Google.Colons>(https://developers.google.com/style/colons)

'Message' should be in lowercase.
Raw output
{"message":"'Message' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":51,"column":28},"end":{"line":51,"column":35}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check failure on line 54 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L54 <Google.EmDash>(https://developers.google.com/style/dashes)

Don't put a space before or after a dash.
Raw output
{"message":"Don't put a space before or after a dash.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":54,"column":71},"end":{"line":54,"column":76}}},"severity":"ERROR","code":{"value":"Google.EmDash","url":"https://developers.google.com/style/dashes"}}

Check warning on line 54 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L54 <Google.OxfordComma>(https://developers.google.com/style/commas)

Use the Oxford comma in ', variables and actions'.
Raw output
{"message":"Use the Oxford comma in ', variables and actions'.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":54,"column":120},"end":{"line":54,"column":143}}},"severity":"WARNING","code":{"value":"Google.OxfordComma","url":"https://developers.google.com/style/commas"}}

Check notice on line 55 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L55 <Google.Acronyms>(https://developers.google.com/style/abbreviations)

Spell out 'OWASP', if it's unfamiliar to the audience.
Raw output
{"message":"Spell out 'OWASP', if it's unfamiliar to the audience.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":55,"column":12},"end":{"line":55,"column":17}}},"severity":"INFO","code":{"value":"Google.Acronyms","url":"https://developers.google.com/style/abbreviations"}}

Check failure on line 55 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L55 <Google.EmDash>(https://developers.google.com/style/dashes)

Don't put a space before or after a dash.
Raw output
{"message":"Don't put a space before or after a dash.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":55,"column":91},"end":{"line":55,"column":96}}},"severity":"ERROR","code":{"value":"Google.EmDash","url":"https://developers.google.com/style/dashes"}}

Check notice on line 55 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L55 <Google.Acronyms>(https://developers.google.com/style/abbreviations)

Spell out 'OWASP', if it's unfamiliar to the audience.
Raw output
{"message":"Spell out 'OWASP', if it's unfamiliar to the audience.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":55,"column":128},"end":{"line":55,"column":133}}},"severity":"INFO","code":{"value":"Google.Acronyms","url":"https://developers.google.com/style/abbreviations"}}

Check notice on line 55 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L55 <Google.Acronyms>(https://developers.google.com/style/abbreviations)

Spell out 'CRS', if it's unfamiliar to the audience.
Raw output
{"message":"Spell out 'CRS', if it's unfamiliar to the audience.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":55,"column":134},"end":{"line":55,"column":137}}},"severity":"INFO","code":{"value":"Google.Acronyms","url":"https://developers.google.com/style/abbreviations"}}

Check warning on line 58 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L58 <Google.Colons>(https://developers.google.com/style/colons)

'Each' should be in lowercase.
Raw output
{"message":"'Each' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":58,"column":17},"end":{"line":58,"column":21}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}

Check warning on line 58 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L58 <Google.Will>(https://developers.google.com/style/tense)

Avoid using 'will'.
Raw output
{"message":"Avoid using 'will'.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":58,"column":133},"end":{"line":58,"column":137}}},"severity":"WARNING","code":{"value":"Google.Will","url":"https://developers.google.com/style/tense"}}

Check notice on line 58 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L58 <Google.Acronyms>(https://developers.google.com/style/abbreviations)

Spell out 'WASM', if it's unfamiliar to the audience.
Raw output
{"message":"Spell out 'WASM', if it's unfamiliar to the audience.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":58,"column":146},"end":{"line":58,"column":150}}},"severity":"INFO","code":{"value":"Google.Acronyms","url":"https://developers.google.com/style/abbreviations"}}

Check warning on line 62 in content/guides/otoroshi.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/guides/otoroshi.md#L62 <Google.Colons>(https://developers.google.com/style/colons)

'Using' should be in lowercase.
Raw output
{"message":"'Using' should be in lowercase.","location":{"path":"content/guides/otoroshi.md","range":{"start":{"line":62,"column":12},"end":{"line":62,"column":17}}},"severity":"WARNING","code":{"value":"Google.Colons","url":"https://developers.google.com/style/colons"}}