Skip to content

Commit

Permalink
docs: adds no_fs_access build tag to docs. (#880)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcchavezs authored Sep 26, 2023
1 parent 2468382 commit f21e300
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,14 @@ func main() {
Go build tags can tweak certain functionality at compile-time. These are for advanced use cases only and do not
have compatibility guarantees across minor versions - use with care.

* coraza.disabled_operators.* - excludes the specified operator from compilation. Particularly useful if overriding
* `coraza.disabled_operators.*` - excludes the specified operator from compilation. Particularly useful if overriding
the operator with `plugins.RegisterOperator` to reduce binary size / startup overhead.
* `coraza.rule.multiphase_valuation` - enables evaluation of rule variables in the phases that they are ready, not
only the phase the rule is defined for.
* `memoize_builders` - enables memoization of builders for regex and aho-corasick
dictionaries to reduce memory consumption in deployments that launch several coraza
instances. For more context check [this issue](https://github.com/corazawaf/coraza-caddy/issues/76)
* `no_fs_access` - indicates that the target environment has no access to FS in order to not leverage OS' filesystem related functionality e.g. file body buffers.

## E2E Testing

Expand Down
3 changes: 2 additions & 1 deletion internal/environment/default.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@

package environment

// HasAccessToFS indicates whether the build environment is TinyGo.
// HasAccessToFS indicates whether the runtime target environment has access
// to OS' filesystem or not.
var HasAccessToFS = true
2 changes: 0 additions & 2 deletions internal/environment/nofsaccess.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@

package environment

// HasAccessToFS indicates whether the build environment has access
// to filesystem or not.
var HasAccessToFS = false

0 comments on commit f21e300

Please sign in to comment.