bonakodo-eric / wallarm-heroku

Wallarm Base Docker Image for Heroku

Wallarm Base Docker Image for Heroku

This repository contains the Dockerfile and necessary resources to build a Wallarm base Docker image for running on Heroku. This image is designed to simplify the deployment process of Wallarm-protected applications on the Heroku platform.

Table of Contents

• Prerequisites
• Getting Started
• Usage
• Configuration
• Troubleshooting
• License

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have a Heroku account. If you don't have one, sign up here.
• You have installed the latest version of Docker.
• You have installed the Heroku CLI.

Usage

To use the Wallarm base Docker image for your Heroku application, follow these steps:

1. Create a Dockerfile in the root of your app directory. Install all necessary dependencies such as your app's runtime. For NodeJS, use the following example:

FROM bonakodo/wallarm-heroku:4.10.2

# Install NodeJS v21 from NodeSource
RUN curl -fsSL https://deb.nodesource.com/setup_21.x | bash - \
  && apt-get install nodejs -qqy \
  && apt-get clean

ADD . /opt/webapp
WORKDIR /opt/webapp

# Install production dependencies and build the app, if necessary
RUN npm install --omit=dev && npm run build
ENV npm_config_prefix /opt/webapp

# Note that in private spaces the `run` section of heroku.yml is ignored
# See: https://devcenter.heroku.com/articles/build-docker-images-heroku-yml#known-issues-and-limitations
CMD ["npm", "run", "start"]

2. Create a heroku.yml configuration file as follows:

# heroku.yml
build:
  docker:
    web: Dockerfile

3. Create a new Heroku application using Docker:

heroku create --stack container --manifest your-app-name

4. Modify your app to listen on /tmp/nginx.socket instead of $PORT as $PORT is already occupied by nginx. For example, in an express app configure port as follows:

// app.js
const app = require('express')()

let port = process.env.PORT || 3000 // If Wallarm is not configured, listen on $PORT
if(process.env.WALLARM_API_TOKEN) port = '/tmp/nginx.socket' // Wallarm is configured

app.listen(port, (err) => {
	if (err) throw err
	console.log(`> App is listening on ${port}`)
})

app.get('/', (req, res) => {
  res.send('This app is protected by Wallarm')
})

5. Push your app

git add Dockerfile heroku.yml app.js package.json
git commit -m "Add Heroku docker config"
git push heroku master

Configuration

The Wallarm base Docker image can be configured using environment variables. The following variables are available:

• WALLARM_API_TOKEN: Your Wallarm API token or node token. If not set, the image skips Wallarm launch and only runs the command specified in CMD (see entrypoint.sh). The value is required.
• WALLARM_API_HOST: The Wallarm Cloud API hostname. Use us1.api.wallarm.com for the US cloud or api.wallarm.com for the EU cloud (default: us1.api.wallarm.com).
• WALLARM_LABELS: The Wallarm node label (default: group=heroku). The group setting is required if you use the API token in place of the node token.
• TT_MEMTX_MEMORY: Memory size allocated for Tarantool in bytes (default: 268435456, i.e., 256 MB).

Set these variables using the heroku config:set command:

heroku config:set WALLARM_API_TOKEN="your-wallarm-api-token" WALLARM_LABELS="group=myfancyapp"

Troubleshooting

If you encounter any issues while using the Wallarm base Docker image, check the Heroku logs for any error messages:

heroku logs --tail

To build this image and debug it locally run:

docker build -t bonakodo/wallarm-heroku:4.10 --target build --platform linux/amd64 .

If you need further assistance, please create an issue in this repository.

License

This dockerfile and configs are licensed under the BSD-3-Clause license. Wallarm node is licensed under its Software License Agreement.