Code Monkey home page Code Monkey logo

gae-standard-springboot-sqreen-sample's Introduction

GoogleAppEngine Standard - SpringBoot Sqreen Sample

This sample shows how to deploy a Spring Boot application protected by Sqreen to Google App Engine stadndard. For simplicity and transparency, the example is based on the sample from GoogleCloudPlatform. Below you will find a Sqreen Integration Guide with required steps to use a Sqrreen Java Agent in the project deployed to the Google App Engine standard.

Prerequisites

  • JDK11
  • Maven
  • Google Cloud console

Run application

  • Set the correct Cloud SDK project via gcloud config set project YOUR_PROJECT to the ID of your application.
  • Put your SQREEN_TOKEN and SQREEN_APP_NAME to src/main/appengine/app.yaml
  • Build and deploy application mvn clean package appengine:deploy
  • View web app gcloud app browse (or navigate https://<your-project-id>.appspot.com)
  • In response HTTP headers you should see string x-protected-by: Sqreen

Sqreen Integration Guide

  1. Download java agent sqreen.jar into dedicated project folder. In the sample java agent located at sqreen/sqreen.jar
  2. To use Sqreen, you need add java agent as JVM startup option. Edit app.yaml and add/modify entrypoint:
entrypoint: 'java -javaagent:sqreen.jar -jar app.jar'
  1. Sqreen requires SQREEN_TOKEN and SQREEN_APP_NAME related to your Sqreen account. Get token and app from your dashboard and add them as environemtn variables to app.yaml:
env_variables:
    SQREEN_APP_NAME: XXXXXXXXX
    SQREEN_TOKEN: env_org_XXXXXXXXX
  1. [Optional] Some web apps has too long startup time, we recommend, for testing purpose, disable healthcheck, to prevent force restart application by Google App Enging. Add command to app.yaml
health_check:
    enable_health_check: False
  1. To make Google App Engine use Sqreen - add external files directory (where the sqreen.jar stored), to maven configuration pom.xml. If you are using Gradle to build your project, you must use similar configuration to include external files (please check official documentation).
<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>appengine-maven-plugin</artifactId>
    ...
    <configuration>
        ....
        <extraFilesDirectories>
            <extraFilesDirectory>sqreen</extraFilesDirectory>
        </extraFilesDirectories>
    </configuration>
</plugin>
  1. Build, deploy and test the app with Sqreen protection.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.