Utility to work with Docker version of LibreOffice in Lambda
$ pnpm add @shelf/aws-lambda-libreoffice
- ESM Module Support: Native ESM package with full TypeScript support
- Includes CJK and X11 fonts bundled in the base Docker image!
- Relies on the latest LibreOffice 7.6 version which is not stripped down from features
- Requires Node.js 22 or higher (x86_64)
First, you need to create a Docker image for your Lambda function. See the example at libreoffice-lambda-base-image repo.
Example:
FROM public.ecr.aws/shelf/lambda-libreoffice-base:7.6-node20-x86_64
COPY ./ ${LAMBDA_TASK_ROOT}/
RUN pnpm install
CMD [ "handler.handler" ]
- At least 3008 MB of RAM is recommended
- At least 45 seconds of Lambda timeout is necessary
- For larger files support, you can extend Lambda's /tmp space using the
ephemeral-storage
parameter - Set environment variable
HOME
to/tmp
This package is now a native ESM module. If you're using CommonJS, you'll need to use dynamic imports or update your project to use ESM.
import {convertTo, canBeConvertedToPDF} from '@shelf/aws-lambda-libreoffice';
export const handler = async () => {
// assuming there is a document.docx file inside /tmp dir
// original file will be deleted afterwards
// it is optional to invoke this function, you can skip it if you're sure about file format
if (!canBeConvertedToPDF('document.docx')) {
return false;
}
return convertTo('document.docx', 'pdf'); // returns /tmp/document.pdf
};
module.exports.handler = async () => {
const {convertTo, canBeConvertedToPDF} = await import('@shelf/aws-lambda-libreoffice');
if (!canBeConvertedToPDF('document.docx')) {
return false;
}
return convertTo('document.docx', 'pdf'); // returns /tmp/document.pdf
};
- Please allocate at least 3008 MB of RAM for your Lambda function.
- If some file fails to be converted to PDF, try converting it to PDF on your computer first. This might be an issue with LibreOffice itself
- If you want to include some fonts/plugins to the libreoffice, contribute to the libreoffice-lambda-base-image instead
- libreoffice-lambda-base-image - a base Docker image for your Lambdas
- serverless-libreoffice - original implementation
- aws-lambda-tesseract
- aws-lambda-brotli-unpacker
- chrome-aws-lambda
The repository now ships two Jest suites and a standalone Lambda harness.
pnpm test:unit
(orpnpm test
) – runs unit tests intests/unit
pnpm test:integration
– spins up the Lambda container through Jest; automatically skips if Podman or the base image is unavailablepnpm test:e2e
– alias for the current integration suite
Use pnpm test:lambda
to exercise the runtime end-to-end. The script bundles the handler, builds a disposable image on top of libreoffice-lambda-base:local
, starts the Lambda runtime with Podman, invokes it once, and streams the conversion summary plus the temp output directory.
Requirements:
podman
installed locally- A base image tagged
libreoffice-lambda-base:local
(override withLIBREOFFICE_LAMBDA_BASE_IMAGE
) pnpm build
completed beforehand (generateslib/index.js
consumed by the bundler)
Handy workflow:
pnpm build
pnpm test:lambda -- --cleanup
--cleanup
deletes the generated fixture output once you are done inspecting it. Additional flags like --bundle
, --fixtures
, and --port
are available for custom runs; see scripts/run-lambda-integration.mjs
for the full list.
$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tags
MIT © Shelf