DEPRECATED: This repository together with others has been merged into the orbiting/backends monorepo. Let's continue the journey there.
This is a lightweight, fast nodejs-express server for asset proxying and image manipulation (resizing, greyscaling, webp format transformation). It streams assets from other urls, from s3 buckets, out of github repos and can render webpages to PNGs.
Check the README of backend-modules-assets which contains all the relevant code.
This backend exposes the express middleware of backend-modules-assets. This was previously handled by republik-backend and publikator-backend themselfs but was extracted to this standalone server to be able to deploy and scale the network heavy image fetching and cpu intensive image resizing independently from the other backends. UnLike the other backends this server does not support auth and depends on express directly.
TODO: system diagram
You need to have node (8.3.0+) installed and postgres running somewhere.
Boostrap your .env file. Also see backend-modules-assets README
PORT=3021
PUBLIC_URL=http://localhost:3021
# must be in sync with PUBLIC_URL
ASSETS_SERVER_BASE_URL=http://localhost:3021
# must be in sync with republik-backend and publikator-backend
ASSETS_HMAC_KEY=aiy3sheYoobahb4eth1ohs4aoPaezeeg
# phantomjscloud.com to render social media share images
PHANTOMJSCLOUD_API_KEY=
# list urls allowed on the /render endpoint, the beginning must match
RENDER_URL_WHITELIST=https://www.republik.ch/
# GITHUB auth server images from github repos
# Follow the "Auth - Github" section of republik-backend to get these
GITHUB_LOGIN=
GITHUB_APP_ID=
GITHUB_INSTALLATION_ID=
GITHUB_APP_KEY=
# base url used on /frontend
FRONTEND_BASE_URL=http://localhost:3010
# whiteliste buckets with regions for /s3
AWS_BUCKET_WHITELIST=republik-assets:eu-central-1
Install dependencies.
yarn install
Run it.
yarn run dev
To develop backend-modules first run yarn run link inside a local copy of the backend-modules repo then execute yarn link @orbiting/backend-modules-xxx here. The specified backend-module is now symlinked inside node_modules and development should work seamlessly.
The source code and it's documentation is licensed under GNU AGPLv3+.