Skip to content

Commit b2d1f59

Browse files
authored
Merge pull request #3721 from Quafadas/s2n_doc
Add doc for installation of s2n
2 parents 8505edc + dad5e7a commit b2d1f59

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

site/getstarted/install.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ libraryDependencies += "co.fs2" %%% "fs2-scodec" % "@VERSION@"
2828
2929
// Node.js only, and requires module support to be enabled
3030
libraryDependencies += "co.fs2" %%% "fs2-io" % "@VERSION@"
31-
scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule))
31+
scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule))
3232
```
3333

3434
The fs2-core as well as fs2-io and fs2-scodec libraries are also supported on Scala Native:
@@ -48,3 +48,17 @@ If upgrading from the 2.x series, see the [release notes for 3.0.0](https://gith
4848
If upgrading from the 1.x series, see the [release notes for 2.0.0](https://github.com/typelevel/fs2/releases/tag/v2.0.0) for help with upgrading.
4949

5050
There are [detailed migration guides](https://github.com/typelevel/fs2/blob/main/docs/) for migrating from older versions.
51+
52+
### Native
53+
54+
For scala native, fs2 has a dependancy on both [s2n](https://github.com/aws/s2n-tls) and [openssl](https://github.com/openssl/openssl). To be able to link a scala-native fs2 based application, s2n and openssl will need to be made available to the linker. If you are observing a linker error in the logs similar to the following on native (commonly, if fs2 is a transitive dependency):
55+
56+
```
57+
[error] ld: library 's2n' not found
58+
```
59+
60+
Then it is recommended to install s2n and openssl. On macOS for example, this can be done with homebrew:
61+
62+
```sh
63+
brew install openssl s2n
64+
```

0 commit comments

Comments
 (0)