Skip to content

Configuration defaults and better documentation #5

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.

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,28 @@ Allows to dig deeper into your application.

* You should have running Spring Boot application with enabled Spring Boot Actuator ```beans``` endpoint.

* You may need to configure Spring Beans Visualized application by modifying constants in ```app.json``` file. Most likely you have to setup your user/password and application host/port, probably Spring Boot Actuator endpoints base path.
* You may need to configure Spring Beans Visualized application by etting environment variables. Most likely you have to setup your user/password and application host/port, probably Spring Boot Actuator endpoints base path.

* Get dependencies & start _Spring Beans Visualized_ application
```
npm install
CLIENT_APP_USER=poweruser CLIENT_APP_PASSWORD=password node app.js
node app.js
```

* Browse your application at ```http://localhost:3000```.


Environment variables are:

* SERVICE_PORT 3000
* CLIENT_APP_USER default 'admin'
* CLIENT_APP_PASSWORD default 'Password1'
* CLIENT_APP_SCHEMA default 'http'
* CLIENT_APP_HOST default 'localhost'
* CLIENT_APP_PORT default '80'
* CLIENT_APP_ACTUATOR_BASE_PATH default '/management'

## Build and run application using Docker

To build and run the application using Docker run next shell commands at project folder:
Expand Down
14 changes: 7 additions & 7 deletions app.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ var express = require('express')
var request = require('request')
var app = express()

var SERVICE_PORT = process.env.SERVICE_PORT
var SERVICE_PORT = process.env.SERVICE_PORT || 3000

var USER = process.env.CLIENT_APP_USER
var PASSWORD = process.env.CLIENT_APP_PASSWORD
var SCHEMA = process.env.CLIENT_APP_SCHEMA
var HOST = process.env.CLIENT_APP_HOST
var PORT = process.env.CLIENT_APP_PORT
var ACTUATOR_BASE_PATH = process.env.CLIENT_APP_ACTUATOR_BASE_PATH
var USER = process.env.CLIENT_APP_USER || 'admin'
var PASSWORD = process.env.CLIENT_APP_PASSWORD || 'Password1'
var SCHEMA = process.env.CLIENT_APP_SCHEMA || 'http'
var HOST = process.env.CLIENT_APP_HOST || 'localhost'
var PORT = process.env.CLIENT_APP_PORT || '80'
var ACTUATOR_BASE_PATH = process.env.CLIENT_APP_ACTUATOR_BASE_PATH || '/management'
var BEANS_URL = SCHEMA + '://' + USER + ':' + PASSWORD + '@' + HOST + ':' + PORT + ACTUATOR_BASE_PATH + '/beans'

var time = function() { return new Date().getTime() }
Expand Down
4 changes: 4 additions & 0 deletions runme
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash
#CLIENT_APP_USER=admin CLIENT_APP_PASSWORD=Password1 CLIENT_APP_HOST=localhost CLIENT_APP_SCHEMA=http CLIENT_APP_PORT=8080 CLIENT_APP_ACTUATOR_BASE_PATH=/management SERVICE_PORT=3000 node app.js

CLIENT_APP_HOST=localhost CLIENT_APP_SCHEMA=http CLIENT_APP_PORT=80 CLIENT_APP_ACTUATOR_BASE_PATH=/. SERVICE_PORT=3000 node app.js