Skip to content

Add doc for installation of s2n #3721

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

Open
Quafadas wants to merge 4 commits into
base: main
Choose a base branch
from
+15 −1
Open

Add doc for installation of s2n #3721

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
531cca6
Add doc for installation of s2n
Quafadas May 5, 2026
51817e9
.
Quafadas May 5, 2026
f74bfef
update per feedback
Quafadas May 5, 2026
dad5e7a
.
Quafadas May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion site/getstarted/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ libraryDependencies += "co.fs2" %%% "fs2-scodec" % "@VERSION@"

// Node.js only, and requires module support to be enabled
libraryDependencies += "co.fs2" %%% "fs2-io" % "@VERSION@"
scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule))
scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule))
```

The fs2-core as well as fs2-io and fs2-scodec libraries are also supported on Scala Native:
Expand All @@ -48,3 +48,17 @@ If upgrading from the 2.x series, see the [release notes for 3.0.0](https://gith
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.

There are [detailed migration guides](https://github.com/typelevel/fs2/blob/main/docs/) for migrating from older versions.

### Native

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):

```
[error] ld: library 's2n' not found
```

Then it is recommended to install s2n and openssl. On macOS for example, this can be done with homebrew:

```sh
brew install openssl s2n
```
Loading