Skip to content

docs: Update versions on README.md #59

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
nekketsuuu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update versions on README.md #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Secrets are fetched in batch via the `ENTRYPOINT`. This is done for you automati

When building your own Lambda Containers, use both the `crypteia` binary and `libcrypteia.so` shared object files that match your platform. Target platform naming conventions include the following:

- Amazon Linux 2: uses the `-amzn` suffix.
- Amazon Linux: uses the `-amzn` suffix.
- Debian, Ubuntu, etc.: uses the `-debian` suffix.

> **Note**
Expand All @@ -84,8 +84,8 @@ When building your own Lambda Containers, use both the `crypteia` binary and `li
There are two options for Lambda containers. The easiest is to use Docker's multi stage builds with our [Extension Containers]([https://github.com/orgs/rails-lambda/packages?ecosystem=container&tab=packages&ecosystem=container&q=extension](https://github.com/orgs/rails-lambda/packages?repo_name=crypteia&q=extension)) to copy the `/opt` directory matching your platform and Crypteia version number. example below. Remember to use `-debian` vs `-amzn` if you are using your own Linux containers. Or change the version number depending on your needs.

```dockerfile
FROM ghcr.io/rails-lambda/crypteia-extension-amzn:1 AS crypteia
FROM public.ecr.aws/lambda/nodejs:18
FROM ghcr.io/rails-lambda/crypteia-extension-amzn:2 AS crypteia
FROM public.ecr.aws/lambda/nodejs:24
COPY --from=crypteia /opt /opt
ENV LD_PRELOAD=/opt/lib/libcrypteia.so
```
Expand Down Expand Up @@ -136,7 +136,7 @@ S3_BUCKET_NAME=my-bucket ./package/deploy
If you are using Crypteia on your own Docker containers without the Lambda Extension mechanics, you can simply set the `ENTRYPOINT` to the Crypteia binary which fetches your environment variables so the shared object preload can use them.

```dockerfile
FROM ghcr.io/rails-lambda/crypteia-extension-amzn:1 AS crypteia
FROM ghcr.io/rails-lambda/crypteia-extension-amzn:2 AS crypteia
FROM ubuntu
COPY --from=crypteia /opt /opt
ENV LD_PRELOAD=/opt/lib/libcrypteia.so
Expand Down